CreateMember
From ePrize Developers Wiki
(Difference between revisions)
(New page: '''Summary''' Create a new member of the loyalty program. The referral id (ref_id) must be included if the user is registering with a referral link. If the user registers as the result o...) |
m |
||
| (2 intermediate revisions not shown.) | |||
| Line 1: | Line 1: | ||
| - | + | ==Summary== | |
Create a new member of the loyalty program. The referral id (ref_id) must be included if the user is registering with a referral link. If the user registers as the result of a referral, the ref_id is returned in the call. Otherwise, ref_id is returned as 0. | Create a new member of the loyalty program. The referral id (ref_id) must be included if the user is registering with a referral link. If the user registers as the result of a referral, the ref_id is returned in the call. Otherwise, ref_id is returned as 0. | ||
| Line 9: | Line 9: | ||
'''Parameters''' | '''Parameters''' | ||
| - | emailAddress | + | * emailAddress |
| - | firstName | + | * firstName |
| - | lastName | + | * lastName |
| - | password | + | * password |
| - | emailOptIn | + | * emailOptIn |
| - | mobileOptIn | + | * mobileOptIn |
| - | SMSNumber | + | * SMSNumber |
| - | ref_id | + | * ref_id |
| - | + | ||
| - | + | ||
| - | + | ||
''Example Request Body:'' | ''Example Request Body:'' | ||
| - | { | + | { |
| - | + | "emailAddress": "jon.doe@helloworld.com”, | |
| - | + | "firstName": "Jon", | |
| - | + | "lastName": "Doe", | |
| - | + | "password": "HelloWorld", | |
| - | + | "emailOptIn": true, | |
| - | + | "mobileOptIn": true, | |
| - | + | "SMSNumber": "877-837-7493", | |
| - | + | "ref_id": "1234567890" | |
| - | + | } | |
| - | } | + | |
''Example Response: Success'' | ''Example Response: Success'' | ||
| - | { | + | { |
| - | + | "token": "0ac198f4ea234d58187b576cf451b37d1fdafd8ba219a24c552aa7fec90f7f3e", | |
| - | + | "userId": 278000000118, | |
| - | + | "refId": 385769300022 | |
| - | + | } | |
| - | } | + | |
''Example Response: Username / Email Address Already Exists'' | ''Example Response: Username / Email Address Already Exists'' | ||
| - | { | + | { |
| - | + | "Error": { | |
| - | + | "Code": "error.business.RuleProcessingException.UserNameAlreadyExists", | |
| - | + | "Message": "User Name Already Exists" | |
| + | } | ||
} | } | ||
| - | } | ||
Current revision
Summary
Create a new member of the loyalty program. The referral id (ref_id) must be included if the user is registering with a referral link. If the user registers as the result of a referral, the ref_id is returned in the call. Otherwise, ref_id is returned as 0. Resource
POST api/v1/createMember
Parameters
- emailAddress
- firstName
- lastName
- password
- emailOptIn
- mobileOptIn
- SMSNumber
- ref_id
Example Request Body:
{
"emailAddress": "jon.doe@helloworld.com”,
"firstName": "Jon",
"lastName": "Doe",
"password": "HelloWorld",
"emailOptIn": true,
"mobileOptIn": true,
"SMSNumber": "877-837-7493",
"ref_id": "1234567890"
}
Example Response: Success
{
"token": "0ac198f4ea234d58187b576cf451b37d1fdafd8ba219a24c552aa7fec90f7f3e",
"userId": 278000000118,
"refId": 385769300022
}
Example Response: Username / Email Address Already Exists
{
"Error": {
"Code": "error.business.RuleProcessingException.UserNameAlreadyExists",
"Message": "User Name Already Exists"
}
}
