Manage user

User details can be edited by submitting a request to the manage user endpoint including all required information. The user is identified by the identifier in the route.

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

• First Name
• Last Name
• Level
• Country
• PartnerMemberId
• Org units

The email address of the user is not changed by this endpoint.

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

    200 - Successfully updated the supplied user
    400 - The payload sent is not correct or valid (missing required field, invalid Level)
    404 - The identifier could not be found (the response body text is ```400- NOT OK```)

[PATCH] /v2/users/{{identifier}}

Route Parameter	Description
identifier	User's identifier, can be retrieved from look up Apis - Required

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

{
    "emailAddress": "[email protected]",
    "firstName" : "FirstName",
    "lastName" : "LastName",
    "country" :"UK",
    "level" :"Basic",
    "partnerMemberId" : "your-identifier",
    "OrgUnitLevels" : [
       "London Gymn",
       "Bristol Gymn"
    ]
}

Field	Description
EmailAddress	User's email address - Required (not changed on the user)
PartnerMemberId	(Optional) Your unique identifier for this user
FirstName	User first name - Required
LastName	User last name - Required
Country	Required - 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	Required - acceptable values are: Basic, Basic Plus, Premium, Premium Plus
OrgUnitLevels	(Optional) list of strings, that break the members down into sub groups of your company (org unit names or Ids, see Org units), only needed if you are sub categorising your members. The user's existing org units are replaced by this list, and removed if it is empty or omitted

If your account is set up to allow anonymous users, PartnerMemberId is required instead of FirstName, LastName and EmailAddress.

A successful response looks like:

{
    "RenewalDate": "2027-05-26",
    "API": "Members",
    "JoinDate": "2026-05-27",
    "LoginUrl": "https://rewards.client.com/preload/client?iframe=ffe2SLrm4qrvyulsci",
    "HubLoginUrl": "https://landing.myezrewards.com/client/default/?iframe=ffe2SLrm4qrvyulsci",
    "Level": "Basic",
    "LastName": "LastName",
    "Status": "Active",
    "FirstName": "FirstName",
    "EmailAddress": "[email protected]",
    "Identifier": 15140131,
    "ExternalMemberId": "your-identifier",
    "OrgUnits": [
        { "Children": null, "Id": 101, "Name": "London Gymn" },
        { "Children": null, "Id": 102, "Name": "Bristol Gymn" }
    ],
    "Action": null
}