EZ Loyalty API - Version 1

Note: Version 1 is legacy and is not part of the public API. Use Version 2.

Endpoints

Create new member

A new member is created by POSTing to the following endpoint:

[POST] /members

Form field	Description
FirstName	Member first name
LastName	Member last name
EmailAddress	Member's email address
PartnerMemberId	(Optional) Your unique identifier for this member
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
Type	New (Case insensitive)
MemberLevel	Acceptable values are: Basic, Basic Plus, Premium, Premium Plus

All form fields are required.

A successful response looks like:

{
    "ResultDetails": "Member created successfully",
    "MemberUrl": "https://rewards.client.com/preload/client?iframe=ffe2SLrm4qrvyulsci",
    "Result": "200-OK"
}

Renew member

Renewing a subscription will set the renewal date to one year from the current date and will set the member status to ‘Active’. Either an EmailAddress or PartnerMemberId must be specified to identify the member that should be renewed.

[POST] /members

Form field	Description
EmailAddress	Member's email address
PartnerMemberId	Your unique identifier for this member
Type	Renewal (Case insensitive)

A successful response looks like:

{
    "ResultDetails": "Member subscription renewed successfully",
    "MemberUrl": "https://rewards.client.com/preload/client?iframe=ffe2SLrm4qrvyulsci",
    "Result": "200-OK"
}

Manage member

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

When a member manage request is received, if a member 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
• MemberLevel
• Email address

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

[POST] /members

Form field	Description
EmailAddress	Member's email address
PartnerMemberId	Your unique identifier for this member
Type	Manage (Case insensitive)
FirstName	Member first name
LastName	Member 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
MemberLevel	Acceptable values are: Basic, Basic Plus, Premium, Premium Plus
NewEmailAddress	New email address

If you wish to change the email address of a member, the new email address should be added as an optional parameter titled ‘NewEmailAddress’. FirstName, LastName and MemberLevel can be changed directly in the submitted parameters.

Cancel member

To cancel a member use the following endpoint and form fields. Either an EmailAddress or PartnerMemberId must be specified to identify the member that should be cancelled.

[POST] /members

Form field	Description
EmailAddress	Member's email address
PartnerMemberId	Your unique identifier for this member
Type	Cancel (Case insensitive)

A successful response looks like:

{
    "ResultDetails": "Member subscription cancelled successfully",
    "Result": "200-OK"
}

Lookup member

Use the following endpoint and form fields to retrieve information related to a specific member. Either an EmailAddress or PartnerMemberId must be specified to identify the member that is being looked up.

[POST] /members

Form field	Description
EmailAddress	Member's email address
PartnerMemberId	Your unique identifier for this member
Type	Lookup (Case insensitive)

A typical response would be:

{
    "RenewalDate": "2024-12-05",
    "API": "Members",
    "JoinDate": "2023-12-06",
    "ResultDetails": "Lookup Results",
    "Result": "200-OK",
    "Identifier": 8791480,
    "MemberURL": "https://rewards.client.com/preload/client?iframe=ffe2SLrm4qrvyulsci",
    "MemberLevel": "Basic",
    "LastName": "LastName",
    "Status": "Active",
    "FirstName": "FirstName",
    "EmailAddress": "[email protected]"
}