Change Journey Status (journey - ChangeJourneyStatus)
Modified on: Mon, Aug 28, 2023 at 8:18 PM
The primary purpose of this call is to allow the user to change the status of a journey. A journey can have one of three states (the journey's status):
- active (by default, the status when first created)
JSON Request Example
|username||Username used to login to Pinpointe|
|usertoken||Unique token assigned to Pinpointe account|
|Journey ID of that journey whose status will be changed. |
NOTE: must be the journey ID. Journey name is not accepted in this call.
|Default status of a newly created journey is "active".|
A journey's status can be changed to "active" (in the event that an active journey had been previously changed to a different status), "suspended", or "inactive".
Please note: ALL OPTIONAL elements that are not used should be deleted from submitted call.
|status||Will return SUCCESS if the journey has been successfully created|
|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?