Workflows
Update Workflow
deprecated
Update editable fields on a workflow such as its name and description. Use the lifecycle endpoints to change run state.
PATCH
Update a workflow by ID
Updates one or more editable fields on a workflow. The
name and description can be edited at any time and the change applies immediately. The workflow’s status cannot be changed through this endpoint, use the dedicated lifecycle endpoints (Pause, Resume, Cancel, Activate) so the audit trail records the intent cleanly.
When to use this
- Renaming a workflow after the underlying campaign or sequence is renamed in your internal systems.
- Editing the description so dashboard viewers see a more accurate summary of what the workflow does.
- Bulk metadata updates when reorganizing workspaces across teams.
Path parameters
Errors
404 Not Foundis returned when the workflow does not exist.400 Bad Requestis returned when the body contains no editable fields or when a value fails validation.409 Conflictis returned if you try to changestatusthrough this endpoint, use the lifecycle endpoints instead.
Related endpoints
- Pause Workflow: change run state.
- Duplicate Workflow: clone before larger edits.
- Get Workflow: confirm the new field values.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
RSA encrypted organization ID (base64 format)
Example:
"BASE64_ENCRYPTED_ORG_ID_HERE"
Path Parameters
Body
application/json
Title of the workflow (max 100 characters)
Maximum string length:
100Example:
"Updated Customer Onboarding Workflow"
Description of the workflow
Example:
"Updated description"
Status of the workflow
Available options:
draft, active, paused, completed, cancelled Example:
"active"
Workflow-level default values for lead variables missing on a lead
Example:
Response
Workflow updated successfully
Update a workflow by ID