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


{
  "username": "JohnDoe",
  "usertoken": "abc123abc123abc123abc123",
  "requesttype": "Journeys",
  "requestmethod": "AddSubscriberToJourney",
  "details": {
    "journey": "{*journey_id or journey_name*}", /* required */
    "subscribers": "{*subscriber_id or subscriber_email*}", /* required */
    "subscribers": "[  /* alternate list format */
      "{*subscriber_id*}",
      "{*subscriber_id*}"
    ]  
  }
}


Null

"json_request" element



Field NameDescription
usernameUsername used to login to Pinpointe
usertokenUnique token assigned to Pinpointe account
requesttypeJourneys
requestmethodAddSubscriberToJourney


"details" element


Field NameDescription
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 NameDescription
statusWill return SUCCESS if the subscriber(s) successfully added to journey.
datajourney ID
subscriber ID(s)
added: number of subscribers added to the specified journey with this call.


Unsuccessful Response:


"response" element


Field NameDescription
statusWill return FAILED if unsuccessful
errormessageText explaining why request failed