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)
- suspended
- inactive
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 | ChangeJourneyStatus |
"details" element
| Field Name | Description |
| journeyid (Required) | Journey ID of that journey whose status will be changed. NOTE: must be the journey ID. Journey name is not accepted in this call. |
| status (Optional) | 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.
Successful Response:
"response" element
| Field Name | Description |
| status | Will return SUCCESS if the journey status has successfully modified. |
| data | journey ID status |
Unsuccessful Response:
"response" element
| Field Name | Description |
| status | Will return FAILED if unsuccessful |
| errormessage | Text explaining why request failed |