Add Subscriber To Journey (journey - AddSubscriberToJourney)
Modified on: Mon, Aug 28, 2023 at 7:45 PM
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.
JSON Request Example
|username||Username used to login to Pinpointe|
|usertoken||Unique token assigned to Pinpointe account|
|Journey ID or journey name that subscriber(s) are to be added to.|
|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.|
(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.
|status||Will return SUCCESS if the journey has been successfully created|
added: number of subscribers added to the specified journey with this call.
|status||Will return FAILED if unsuccessful|
|errormessage||Text explaining why request failed|
Did you find it helpful?
Can you please tell us how we can improve this article?