Skip to content

Delete a workflow and cancel pending reminders

DELETE
/appointments/workflows/{workflow_id}

Delete a workflow and cancel any pending reminder rows created by it. Mirrors the in-app router: cancel_workflow_reminders is called BEFORE delete_workflow so reminder FK constraints are satisfied and scheduled worker jobs for this workflow never fire after deletion.

Authorizations

Parameters

Path Parameters

workflow_id
required

Workflow integer ID.

integer
>= 1

Workflow integer ID.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

204

Successful Response

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string