Activate or deactivate a workflow

POST

/appointments/workflows/{workflow_id}/toggle

• Production
• QA

Set the workflow’s active state. When deactivating (active: false), all pending reminders are cancelled first (same behaviour as the in-app toggle) so the reminder worker never fires steps for a disabled workflow.

Authorizations

• BearerAuth

Parameters

Path Parameters

workflow_id

required

Workflow integer ID.

integer

>= 1

Workflow integer ID.

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Request Body ^required

object

active

required

boolean

Responses

200

Successful Response

object

key

additional properties

any

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string