agency-board

POST /v1/agency/boards/{boardId}/automations

Create a rule — when this happens, only if that, then do these.

Všechny koncové body agency-board

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ázevTypPožadovánoCo to je
boardId (path)UuidAnoProject board ID (UUIDv7).

Tělo požadavku

NázevTypPožadovánoCo to je
namestringAno
descriptionstringNe
triggerstringAno
trigger_configobjectNePer-trigger settings, e.g. `hours_before` for "due date approaching".
conditionsBoardAutomationCondition[]NeANDed. An empty list means the rule always matches its trigger.
actionsBoardAutomationAction[]Ne
statusstring<enabled, disabled>Ne
positionintegerNe

Odpověď

NázevTypPožadovánoCo to je
idUuidAnoUUIDv7 identifier — sortable by creation time (docs/02 §8).
board_idUuidAnoUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringAno
descriptionstringNe
triggerstringAno
trigger_configobjectNe
conditionsBoardAutomationCondition[]Ne
actionsBoardAutomationAction[]Ne
statusBoardAutomationStatusAno`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…
positionintegerNe
run_countintegerNe
fired_countintegerNe
consecutive_failuresintegerNe
suspended_reasonstringNeWhy 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_atstringNe
last_fired_atstringNe
last_run_atstringNe
next_due_atstringNeOnly set for a wall-clock rule. Null for a rule on a live act.
created_atstringNe
updated_atstringNe

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422