This call allows the user to create a journey via the API by specifying the list the journey will target and what newsletter (whether a "standard" newsletter template or a "journeys" newsletter template) that will be sent to the target list.
The user may also allow the journey to be re-entrant, meaning the journey will automatically terminate with an "unenroll" node, which allows a user who has already passed through the journey to be re-enrolled. This option will be discussed more fully below.
NOTE: This same call can be found under the request type 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 | AddJourneyNewsletter |
"details" element
Field Name | Description |
list (Required) | ID number of the list to be targeted by the journey |
send_newsletter (required) | The newsletter template ID or name to be sent to those contacts who are enrolled in this journey |
resend (optional) | Set as true, 1 or yes to allow journey to be reentrant. Default is zero, false, or no. NOTE: You cannot make an EXISTING journey reentrant if that journey is "active" or "suspended". The journey must first be made "inactive", either through the GUI or via the journey-ChangeJourneyStatus API call. Once the inactive journey has been made reentrant, the user may make it active or suspended once again. |
Please note: ALL OPTIONAL elements that are not used should be deleted from submitted call.
Successful Response:
"response" element
Field Name | Description |
status | Will return SUCCESS if the journey has been successfully created |
data | List ID Campaign ID New Journey ID New: Boolean response of either "true" or "false" indicating whether this journey is new or is an existing journey whose reentrant status is being changed Resend: If journey is inactive, return data will indicate results of call. If journey is active or suspended, returned data will indicate status could not be changed as a result. |
Unsuccessful Response:
"response" element
Field Name | Description |
status | Will return FAILED if unsuccessful |
errormessage | Text explaining why request failed |