Allows user to add one or more subscribers to an active Journey.
NOTE: subscribers to be added to the specified journey MUST already be present in the specified list.
Note: this API call can also be found under the requesttype = Journeys
JSON Request Example:
{
"username": "[email protected]",
"usertoken": "abc123abc123abc123abc123abc123",
"requesttype": "Newsletters",
"requestmethod": "AddSubscriberToJourney",
"details": {
"journey": "{*journey_id or journey_name*}", /* required */
"subscribers": "{*subscriber_id*}", /* required */
"subscribers": [ /* alternate list format */
"{*subscriber_id*}",
"{*subscriber_id*}"
]
}
}"json_request" element
| Field Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token assigned to Pinpointe account |
| requesttype | Newsletters |
| requestmethod | AddSubscriberToJourney |
"details" element
Please note: Unused optional parameters should be deleted from the call.
| Elements | |
| journey (required) | User must provide either the Journey ID or the Journey name. |
| subscribers | The subscriber ID of the subscriber the user wants added to the specific Journey. |
| subscribers (alternate) | User may supply a list of comma-separated subscriber IDs in the case where more than one subscriber is to be added to the specified Journey. |
Successful Response:
"response" element
| Field Name | Description |
| status | Will return SUCCESS if subscriber is successfully added to the specified Journey |
"response" "data"
| Field Name | Description |
| data | Journey ID, ID of subscriber(s) added, and the subscriber count. |
Unsuccessful Response:
"response" element
| Field Name | Description |
| status | Will return FAILED if unsuccessful |
| errormessage | Text explaining why request failed |