Disable automation workflow

Disable an automation workflow. Once disabled, the workflow stops
accepting new trigger events.

Use contactsInWorkflow to control what happens to contacts
currently progressing through the workflow:

  • keep: contacts remain and continue through the remaining blocks
    until completion. No new contacts enter.
  • exit: all contacts are immediately removed from the workflow.
    Contacts who have not yet received their messages will not receive them.

Disabling an already-disabled automation is idempotent — returns the
current state without side effects.

Scopes:
automations.write

Path Params
string
required

Automation workflow ID (24 character hexadecimal)

Body Params

Disable options

Disable an automation workflow. Once disabled, the workflow stops accepting new trigger events. The contactsInWorkflow field determines what happens to contacts currently progressing through the workflow: - "keep": contacts remain in the workflow and continue through the remaining blocks until completion. No new contacts enter. - "exit": all contacts are immediately removed from the workflow. Contacts who have not yet received their messages will not receive them.

string
enum
required

What to do with contacts currently in the workflow

Allowed:
Headers
string
required
Defaults to 2026-03-15

API version that specifies the response format and behaviour

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json