agency-board
POST /v1/agency/boards/{boardId}/automations
Create a rule — when this happens, only if that, then do these.
Authentication
Send an API key as a bearer token. The endpoint checks agency.board.manage; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/automations \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string>, "trigger": <string> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Validated against the catalogue at save time, not at run time. A rule pairing a card action with a trigger that carries no card, naming a context field its trigger does not publish, or using an operator the field's type cannot take is refused here with the offending clause named — because the alternative is a rule that sits in the list looking enabled and does nothing for ever, whose only evidence is an absence.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
boardId (path) | Uuid | Yes | Project board ID (UUIDv7). |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
name | string | Yes | — |
description | string | No | — |
trigger | string | Yes | — |
trigger_config | object | No | Per-trigger settings, e.g. hours_before for "due date approaching". |
conditions | BoardAutomationCondition[] | No | ANDed. An empty list means the rule always matches its trigger. |
actions | BoardAutomationAction[] | No | — |
status | string<enabled, disabled> | No | — |
position | integer | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Yes | — |
description | string | No | — |
trigger | string | Yes | — |
trigger_config | object | No | — |
conditions | BoardAutomationCondition[] | No | — |
actions | BoardAutomationAction[] | No | — |
status | BoardAutomationStatus | Yes | suspended means WE paused it after repeated failure and it carries a reason the customer has not read. It is a third state rather than a reuse of disabled, because collapsing… |
position | integer | No | — |
run_count | integer | No | — |
fired_count | integer | No | — |
consecutive_failures | integer | No | — |
suspended_reason | string | No | Why we paused this rule, in authored copy from a closed table — never an exception, a status or a message from our own code. The per-failure detail lives on each run… |
suspended_at | string | No | — |
last_fired_at | string | No | — |
last_run_at | string | No | — |
next_due_at | string | No | Only set for a wall-clock rule. Null for a rule on a live act. |
created_at | string | No | — |
updated_at | string | No | — |
Errors this endpoint can return
401 · 403 · 404 · 422