Create New User

Create new user

A new user is created by POSTing the following JSON body to the endpoint:

HTTP Response Values

    200 - Successful creation of a new user
    400 - The payload sent is not correct or valid (missing required field, invalid Level or Country)
    409 - A user already exists with that email address or PartnerMemberId

[POST] /v2/users/

{
    "EmailAddress": "email@ez-loyalty.com",
    "PartnerMemberId" : "your-identifier",
    "FirstName" : "FirstName",
    "LastName" : "LastName",
    "Country" :"UK",
    "Level" :"Basic",
    "OrgUnitLevels" : [
       "London Gymn",
       "Bristol Gymn"
    ]
}

Name	Description
FirstName	User first name - Required
LastName	User last name - Required
EmailAddress	User's email address - Required
PartnerMemberId	(Optional) Your unique identifier for this user
Country	Required - see Country List
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

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

A successful response looks like:

HTTP/1.1 200 OK

{
    "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@ez-loyalty.com",
    "Identifier": 15140131,
    "ExternalMemberId": "your-identifier",
    "OrgUnits": [
        { "Children": null, "Id": 101, "Name": "London Gymn" },
        { "Children": null, "Id": 102, "Name": "Bristol Gymn" }
    ],
    "Action": null
}

• Level is returned without spaces (e.g. BasicPlus).
• EmailAddress is stored in lower case.
• RenewalDate is set to one year from the join date (less one day).
• OrgUnits only contains the top level org units, with their children nested under Children.