Opt Customer In/Out
This endpoint opts a customer in or out of the program. It is used to update customer enrollment status. Once a customer has opted in to the program they should begin seeing their offers.
| PUT /customers/<token>/enrollment
|
In addition to the query parameter, this endpoint requires a JSON body be posted.
| Path Param |
Type |
Required |
Description |
| token |
string |
Required |
The security token for the customer |
| Query Param |
Type |
Required |
Description |
| channelId |
int |
Required |
Value from Channel list |
| locationId |
int |
Required |
Value from Location list |
| JSON Prop |
Type |
Required |
Description |
| optIn |
boolean |
Required |
A boolean value to indicate if customer is enrolled or not |
Output
This endpoint returns an HTTP response indicating success (200) or failure (500).
Example
Request
| PUT /api/v1/customers/C1FA3C38-1B28-4B54-A2F8-E577FFEEF9F5/enrollment?channelId=1&locationId=4
|
Response