Skip to content

Manage User

Lee Sambridge edited this page May 29, 2024 · 15 revisions

Manage user

User details can be edited by submitting a request to the manage user endpoint including all required information. Either an EmailAddress or PartnerMemberId must be specified to identify the user that is being changed.

When a user manage request is received, if a user exists with a matching login, that record will be updated to reflect the submitted information. The fields that are updated are:

  • First Name
  • Last Name
  • level
  • Email address

Managing members would typically be used to upgrade or downgrade a User level i.e. Basic -> Premium, Premium -> Premium Plus, Premium -> Basic etc…

HTTP Response Values

    HTTP - 200 - Successfully updated the supplied user
    HTTP - 400 - The payload sent is not correct or valid
    HTTP - 404 - Either the email address or the Partner User Id used could not be found

[PATCH] /v2/users/?emailAddress={{emailAddress}}

Managing a membership by PATCHing the following JSON body to the endpoint:

{
    "emailAddress": "test@endurancezone.com",
    "firstName" : "FirstName",
    "lastName" : "LastName",
    "country" :"UK",
    "memberLevel" :"Basic",
    "partnerMemberId" : ID
}
Field Description
EmailAddress User's email address
PartnerMemberId Your unique identifier for this user
FirstName User first name
LastName User last name
Country Acceptable values are: USA, UK, Canada, Europe, Mexico, Australia, New Zealand, Africa, India, Dubai, Austria, Belgium, Bulgaria, Switzerland, Germany, Denmark, Spain, France, Ireland, Italy, Luxembourg, Monaco, Netherlands, Norway, Sweden, Singapore, South Africa, UAE - *additional countries can be enabled as part of the onboarding
level Acceptable values are: Basic, Basic Plus, Premium, Premium Plus

A successful response looks like:

{
    "ResultDetails": "User details updated successfully",
    "User": {
        "RenewalDate": "2025-05-27",
        "JoinDate": "2024-04-25",
        "loginUrl": "https:///preload/sport80?iframe=vgnppl6vhJpUq1q2EaPV",
        "level": "Basic",
        "LastName": "LASTNAME",
        "Status": "Active",
        "FirstName": "FIRSTNAME",
        "EmailAddress": "email@emai.com",
        "Id": 15006401
    }
}

Clone this wiki locally