The primary purpose of this call is to allow the user to send a journey-associated newsletter (can be a "normal" newsletter or a Journey newsletter) to one or more subscribers in a single specified list. IF the Journey has not yet been created, the call will automatically create an active Journey.
NOTE: subscribers to receive the specified newsletter MUST already be present in the specified list.
NOTE: If Journey already exists, Journey MUST be active, or if suspended, will launch journey newsletter once reactivated.
NOTE: Can resend same newsletter to same contact multiple times using this call.
Note: This call can also be found under the requesttype: "news "
JSON Request Example
{
"username": "JohnDoe",
"usertoken": "abc123abc123abc123abc123",
"requesttype": "Journeys",
"requestmethod": "SendJourneyNewsletter",
"details": {
"list": "{*list_id or list_name*}", /* required */
"send_newsletter": "{*newsletter_id or newsletter_name*}", /* required */
"subscribers": "[ /* alternate list format */
"{*subscriber_id*}",
"{*subscriber_id*}"
]
}
}
"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-based newsletter has been successfully sent to the included subscribers. |
| 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 |