Workflows API
Errors
Every error is a JSON object with one error string, written so you can show it to a person as is.
| Status | Meaning |
|---|---|
200 / 201 | Success |
400 | An invalid field, a trigger or action that doesn't fit the record type, or a reference outside your workspace |
401 | Missing, malformed, expired or revoked API key |
403 | The key lacks read:workflows (for GET) or write:workflows (for POST, PATCH, DELETE) |
404 | No workflow with that ID in your workspace |
429 | Rate limit exceeded |
Examples
{ "error": "Task automations can only use the CREATED trigger." }{ "error": "The STALLED trigger only works on DEAL workflows." }{ "error": "Inbound email automations can only use the CREATED trigger, which fires when a message arrives." }{ "error": "Deals have no status field, so SET_FIELD can't be used on DEAL workflows." }{ "error": "SET_FIELD status on a LEAD workflow must be one of: NEW, WORKING, QUALIFIED, UNQUALIFIED, CONVERTED." }{ "error": "ADD_TAG needs exactly one of tag (a tag name) or tagId." }{ "error": "Notify target not found. Use \"owner\", an email address, or the id of an active user in this workspace." }{ "error": "Sequence not found in this workspace." }{ "error": "The olderThanDays condition on \"lastActivityAt\" needs a number of days as its value." }