...
| Warning |
|---|
This API is not complete. It is not yet scheduled for development. A single API call was created (subscribe) to meet the needs of merchants. The remainder of this API will be completed in 2014+. Thanks. |
| Table of Contents |
|---|
...
/rest/autoresponder/subscribe
Method | GET | Comments |
|---|---|---|
| Description | enrolls a customer into a campaign |
|
Cookies | none | |
| Path Parameters | none |
|
| Query Parameters | _mid campaignOid name | Merchant ID ( this can also be passed as a cookie or header – see notes in the Introduction) Integer, campaign id. You may find this on the main Auto Responder page in the Campaigns table. It's the first column. Email of customer to enroll Optional first and last name. If this is null, the email is inserted in this field also |
| Headers | none | |
| Receives Json | none | |
| Returns Json | None. Plain Text | Here are the various return messages:
Discussion: If the customer does not exist in the campaign and everything works, If the customer exists, and in a finished state, and the campaign is set to re-enroll, then the customer is re-enrolled and If the customer exists and the campaign is not configured for re-enrollment, failure. already enrolled and no re-enrollment. is returned. If the customer exists and re-enrollment is turned on, yet the customer is in progress, nothing is done and failure. customer is enrolled and in-progress. nothing done. is returned. It's important to realize the none of the above conditions are bad. Each message above is indicative of a healthy auto responder. success/failure pertains to enroll, but regards business logic.
If there is a server error, a 500 status code will return. If there is invalid or missing parameters, a 400 status code will return. Those are the issues you need to worry about. |
...