Skip to main content
PUT
This endpoint is for the VIP plan only. Other plans get a 403. See Plan access.
Replace the name and every step. Send the whole list of steps, not the ones that changed.
On a published workflow, the new steps go live at once. New runs use them right away. So a PUT on a published workflow passes the same checks as Publish first. If a step is not ready, we answer 400 and save nothing. The version number does not change until you publish again.A PUT on a published workflow cannot change its trigger. To change the trigger, unpublish the workflow, send the PUT, then publish it again. If the workflow is published or unpublished while your PUT runs, we answer 409 and save nothing. Send it again.

Path Parameters

string
required
The workflow’s id.

Body

string
required
The workflow’s name, up to 200 characters.
array
required
The trigger and the steps, up to 500.

Steps

Each item in nodes is the trigger or a step. Rules for steps:
  • Webhook headers are write only. A sendWebhook step takes headers as names and text values. We do not send the values back. Responses show headerNames in their place.
  • Keep or change headers. Leave headers out to keep the saved ones. That works while the url stays on the same address. To move the step to another address (a different host, http or https, or port), send headers again, or send {} to remove them. Otherwise we answer 400.
  • Header names and values. A header name must be a plain name, and Host, Content-Length, Transfer-Encoding and Connection are not allowed. A value must be text on one line.
  • Webhook addresses. A new or changed url may not point to a private or internal address. We cannot check a url with a {{variable}} in it ahead of time.
  • Secrets go in headers. Only headers are write only. The url (with its query), body and bodyFields come back when you read the workflow or its versions. Put tokens and keys in headers.
  • DND. The API never saves or runs a step that turns DND off (updateContact with "dnc": "deactivate"). If you send one, or the workflow already has one from the dashboard, we answer 400: “This workflow has a step that turns DND off. Remove that step in the dashboard first.” A step can turn DND on.
  • Lead Connector. The step that changes a contact in Lead Connector is updateLeadConnectorContact.
Each step that sends a message or makes a call checks DND for the contact when it runs.

Errors