Stop the execution of a workflow

Stop the execution of a workflow for a subscriber.

This operation is a no-op if the subscriber is not executing the worklfow.

Resource URL:

POST https://api.essential.to/v2/account/channels/{channel_sid}/subscribers/{phone_number_or_sid}/automation_workflow_executions/stop

Resource information:

Response formatJSON
Requires authentication?Yes

Parameters:

sid
required

The SID of the automation workflow whose execution should be stopped.

reason
required

A description of why the workflow is being stopped.

Sample code:

curl \
  -X POST \
  -u '[SID]:[TOKEN]' \
  -H 'Content-Type: application/json' \
  -d '{ \
    "sid": [WORKFLOW_SID], \
    "reason": "Customer moved to new group" \
  }' \
  'https://api.essential.to/v2/account/channels/p03Gjl8Uzn0RkZSpHXHnrw/subscribers/15009998080/automation_workflow_executions/stop'

# Sample response
202 Accepted
Python coming soon.
Node coming soon.