agency-board
POST /v1/agency/boards/{boardId}/automations
Create a rule — when this happens, only if that, then do these.
Autentizace
Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
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> }'Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
boardId (path) | Uuid | Ano | Project board ID (UUIDv7). |
Tělo požadavku
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
name | string | Ano | — |
description | string | Ne | — |
trigger | string | Ano | — |
trigger_config | object | Ne | Per-trigger settings, e.g. `hours_before` for "due date approaching". |
conditions | BoardAutomationCondition[] | Ne | ANDed. An empty list means the rule always matches its trigger. |
actions | BoardAutomationAction[] | Ne | — |
status | string<enabled, disabled> | Ne | — |
position | integer | Ne | — |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
id | Uuid | Ano | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Ano | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Ano | — |
description | string | Ne | — |
trigger | string | Ano | — |
trigger_config | object | Ne | — |
conditions | BoardAutomationCondition[] | Ne | — |
actions | BoardAutomationAction[] | Ne | — |
status | BoardAutomationStatus | Ano | `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 collapsin… |
position | integer | Ne | — |
run_count | integer | Ne | — |
fired_count | integer | Ne | — |
consecutive_failures | integer | Ne | — |
suspended_reason | string | Ne | 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 (`action_re… |
suspended_at | string | Ne | — |
last_fired_at | string | Ne | — |
last_run_at | string | Ne | — |
next_due_at | string | Ne | Only set for a wall-clock rule. Null for a rule on a live act. |
created_at | string | Ne | — |
updated_at | string | Ne | — |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404 · 422