Used to cause a user or a list of users to finish a multi-stage journey, preventing them from receiving more messages.


Cancelling a multi-stage campaign journey, targeting a single user by user ID.

curl --request POST \
  --url \
  --header 'content-type: application/json' \
  --data '{
    "apptoken": "YOURAPPTOKEN",
    "id": "CAMPAIGNID",
    "target_by": "user_id",
    "target": "user1"

Example response:

    "success": true,
    "code": 200,
    "message": {
        "campaign_id": CAMPAIGNID,
        "profile_id": "PROFILEID",
        "0": {
            "workflow_id": WORKFLOWID,
            "new_cancelled_journeys": 0,
            "already_cancelled": 1,
            "already_completed": 0
        "new_cancelled_journeys_total": 0,
        "already_cancelled_total": 1,
        "already_completed_total": 0
Click Try It! to start a request and see the response here!