Register a loyalty program member
Request Information
Headers
| Name | Description | Type | Additional information |
|---|---|---|---|
| Authentication |
Authentication token |
string |
Required |
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| accountid |
Your account id |
globally unique identifier |
Required |
Body Parameters
New loyalty program member
ApiLPMember| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
ID. Leave empty when adding a new member. |
globally unique identifier |
None. |
| FirstName |
Firstname |
string |
Max length: 250 Required |
| LastName |
Lastname |
string |
Max length: 250 |
| Phone |
Phone |
string |
Max length: 20 |
|
|
string |
Max length: 250 |
|
| Birthday |
Birthday date |
date |
None. |
| BirthdayYear |
Birthday year |
integer |
None. |
| Gender |
Gender. Can be M - Male, F - Female, N - Not Applicable |
character |
None. |
| Notes | string |
Max length: 500 |
|
| StatusCode |
Status code. Should be set for Update only. Can be 'A' (active) and 'D' (disabled) |
character |
None. |
| PointBalance |
Current point balance for user. |
integer |
None. |
| ExternalAccountId |
And Id for the member in your external platform. Same as the "Member ID" field on the member registration screen. Leave blank if not used. |
string |
Max length: 500 |
| IgnoreWebHook | boolean |
None. |
Request Formats
application/json
Sample:
{
"FirstName": "First name",
"LastName": "Last name",
"Phone": "972 999 9999",
"Email": "someemail@gmail.com",
"Birthday": "2014-04-01T12:13:19.903",
"BirthdayYear": 2014,
"Gender": "M",
"Notes": "Any notes",
"ExternalAccountId": "Any external account id if exist",
"StatusCode": "A",
"IgnoreWebHook": true
}
Response Information
Resource Description
Added member information
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | ApiLPMember |
None. |
|
| Success | boolean |
None. |
|
| Messages | Collection of ErrorMessage |
None. |
Response Formats
application/json
Sample:
{
"Data": {
"Id": "30F0B01C-8B37-4D64-86BC-C2C88F9CA276",
"FirstName": "First name",
"LastName": "Last name",
"Phone": "972 999 9999",
"Email": "someemail@gmail.com",
"Birthday": "2014-04-01T12:13:19.903",
"BirthdayYear": 2014,
"Gender": "M",
"Notes": "Any notes",
"ExternalAccountId": "Any external account id if exist",
"StatusCode": "A",
"StatusDescription": "Active"
},
"Success": true,
"Messages": []
}