Skip to main content
GuidesAPI Reference

Deactivate a workflow

PUT 
/workflows/deactivate

Disables all future invocations and runs for a given workflow.

By deactivating a workflow, this endpoint will turn off any events or webhooks a workflow is subscribed to. May be reactivated by the Reactivate workflow endpoint.

Request​

Header Parameters

    Authorization stringrequired

    Default value: bearer YOUR_API_KEY

Body

    userId stringrequired

    The Id of the user you want to lookup. Returned from the Create User endpoint. Note: you can also use the Embedded user's username in this field.

    workflowId string

    The Id of the workflow to activate. If you pass this parameter, then workflowName is not required.

    workflowName string

    The name of the workflow to activate. If you pass this parameter, then workflowId is not required.

Responses​

200

Schema

    activated boolean

    Default value: true

Loading...