Pipelines API
Errors
Every error is a JSON object with a single error string, written to be shown to a person.
| Status | Meaning |
|---|---|
200 | Success |
201 Created | A pipeline or stage was created |
400 Bad Request | A missing or invalid field, a stage that is both won and lost, an incomplete reorder list, or deleting the last pipeline or stage |
401 Unauthorized | Missing, malformed, expired, or revoked API key |
403 Forbidden | The key lacks read:pipelines (for GET) or write:pipelines (everything else) |
404 Not Found | A pipeline, stage or moveDealsTo stage that is not in this workspace |
409 Conflict | Deleting a pipeline or stage that still has deals, without moveDealsTo |
429 Too Many Requests | Rate limit exceeded. See the Retry-After header |
Examples
{ "error": "A stage can't be both won and lost." }{ "error": "stageIds must list all 5 stages of this pipeline." }{ "error": "You can't delete your only pipeline." }{ "error": "A pipeline needs at least one stage." }{ "error": "This stage still has 3 deal(s). Pass moveDealsTo with another stage id to move them first." }{ "error": "The moveDealsTo stage was not found in this workspace." }