agency-board
POST /v1/agency/boards/{boardId}/automations
Create a rule — when this happens, only if that, then do these.
Autentificare
Trimiteți o cheie API ca token de tip bearer. Acest punct final nu specifică o permisiune anume în specificație, așa că acordați cheii cele mai puține drepturi necesare și verificați răspunsul în loc să faceți presupuneri.
Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.
Încearcă
Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.
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> }'Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API
Detalii
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.
Parametri
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
boardId (path) | Uuid | Da | Project board ID (UUIDv7). |
Corp cerere
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
name | string | Da | — |
description | string | Nu | — |
trigger | string | Da | — |
trigger_config | object | Nu | Per-trigger settings, e.g. `hours_before` for "due date approaching". |
conditions | BoardAutomationCondition[] | Nu | ANDed. An empty list means the rule always matches its trigger. |
actions | BoardAutomationAction[] | Nu | — |
status | string<enabled, disabled> | Nu | — |
position | integer | Nu | — |
Răspuns
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
id | Uuid | Da | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Da | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Da | — |
description | string | Nu | — |
trigger | string | Da | — |
trigger_config | object | Nu | — |
conditions | BoardAutomationCondition[] | Nu | — |
actions | BoardAutomationAction[] | Nu | — |
status | BoardAutomationStatus | Da | `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 | Nu | — |
run_count | integer | Nu | — |
fired_count | integer | Nu | — |
consecutive_failures | integer | Nu | — |
suspended_reason | string | Nu | 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 | Nu | — |
last_fired_at | string | Nu | — |
last_run_at | string | Nu | — |
next_due_at | string | Nu | Only set for a wall-clock rule. Null for a rule on a live act. |
created_at | string | Nu | — |
updated_at | string | Nu | — |
Erori pe care le poate returna acest punct final
401 · 403 · 404 · 422