Repository navigation
Manage User
lsambridge edited this page Dec 20, 2024
·
15 revisions
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
- Country
Managing members would typically be used to upgrade or downgrade a User level i.e. Basic -> Premium, Premium -> Premium Plus, Premium -> Basic etc…
200 - Successfully updated the supplied user
400 - The payload sent is not correct or valid
404 - Either the email address or the Partner User Id used could not be found
[PATCH] /v2/users/{{identifier}}
Managing a membership by PATCHing the following JSON body to the endpoint:
{
"emailAddress": "test@endurancezone.com",
"firstName" : "FirstName",
"lastName" : "LastName",
"country" :"UK",
"level" :"Basic",
"partnerMemberId" : "your-identifier",
"OrgUnitLevels" : [
"London Gymn",
"Bristol Gymn"
]
}| 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
|
| OrgUnitLevels | list of strings, that break the members down into sub groups of your company, only needed if you are sub catergorising your members |
A successful response looks like:
{
"id": 15140131,
"loginUrl": "https://rewards.client.com/preload/client?iframe=ffe2SLrm4qrvyulsci",
"level": "Basic",
"firstName": "FirstName",
"lastName": "LastName",
"status": "Active",
"emailAddress": "test@endurancezone.com",
"country": "UK",
"partnerMemberId": "your-identifier"
}- Frequently Asked Questions
-
EZ Loyalty Points Api
- Authorization
- Summary
- End Points
- Branding End Points
- Buckets End Points
- Competition End Points
- Country End Points
- Leader Boards End Points
- Machine Learning End Points
- Partner Activities End Points
- Partner End Points
- Partner FAQs End Points
- Partner Level Points End Points
- Reward Points End Points
- Subscriptions End Points
- Users End Points
- User Points End Points
- EZ Loyalty Admin Api