The primary purpose of this call is to allow the user to add one or more subscribers to an existing journey. A single subscriber may be added as a single value for the first listed parameter, "subscribers", OR, multiple subscribers may be added in the form of a multi-element array (list) using the second version of the parameter, "subscribers".
NOTE: subscribers to be added to the specified journey MUST already be present in the specified list.
Note: adding a contact to a journey via this call will insert the contact into the journey funnel, IRRESPECTIVE of the Journey's actual entrant event(s) requirement.
Note: this API call can also be found under the requesttype = Newsletters
JSON Request Example
"json_request" element
Field Name | Description |
username | Username used to login to Pinpointe |
usertoken | Unique token assigned to Pinpointe account |
requesttype | Journeys |
requestmethod | AddSubscriberToJourney |
"details" element
Field Name | Description |
journey (Required) | Journey ID or journey name that subscriber(s) are to be added to. |
subscribers (required) | Subscriber's email address or subscriber ID who is to be added to the specified journey. May only add a single parameter using this call format. |
subscribers (alternate array-based parameter) | Subscriber(s) email address(s) or subscriber ID(s) that are to be added to the specified journey. May specify a single or multiple subscribers using JSON array (list) syntax. |
Please note: ALL ALTERNATE elements that are not used should be deleted from submitted call.
Successful Response:
"response" element
Field Name | Description |
status | Will return SUCCESS if the subscriber(s) successfully added to journey. |
data | journey ID subscriber ID(s) added: number of subscribers added to the specified journey with this call. |
Unsuccessful Response:
"response" element
Field Name | Description |
status | Will return FAILED if unsuccessful |
errormessage | Text explaining why request failed |