The primary purpose of this call is to allow the user to send a journey-based newsletter to one or more subscribers in a single specified list.
NOTE: subscribers to receive the specified newsletter MUST already be present in the specified list.
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 | SendJourneyNewsletter |
"details" element
Field Name | Description |
list (required) | list ID target NOTE: any specified subscriber MUST already be present in the specified list |
send_newsletter (required) | newsletter_id or newsletter_name to be sent. |
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 journey has been successfully created |
data | journey ID subscriber ID(s) added: number of subscribers added that received the specified newsletter. |
Unsuccessful Response:
"response" element
Field Name | Description |
status | Will return FAILED if unsuccessful |
errormessage | Text explaining why request failed |