agency-board

PATCH `/v1/agency/boards/{boardId}/automations/{ruleId}`

Change a rule, or pause and resume it.

Ìfàṣẹ́pọ̀

Fi bọ́kì kọ́kọ́ (bearer token) ránṣẹ́ gẹ́gẹ́ bí àmì ìdánimọ̀ API. Ibùdó yìí kò sọ àṣẹ pàtó kan nínú àlàyé rẹ̀, nítorí náà fún kọ́kọ́ rẹ̀ ní ohun tó kéré jù lọ tí ó nílò kí o sì ṣàyẹ̀wò ìdáhùn náà dípò kí o kàn rò ó.

Ojú abánisọ̀rọ̀ yìí kò gba id ajọ kankan. Kọ́kọ́rọ́ rẹ ti mọ ajọ ti o jẹ ti e, a o si fèsì nipa rẹ̀.

Gbiyanju rẹ

Rọ́pọ̀ èyíkéyìí nínú àwọn àmì ìtọ́ka < > pẹ̀lú iye tirẹ̀, àti àmì ìdánimọ̀ bọ́tìnnì náà pẹ̀lú bọ́tìnnì kan láti inú dásibọ̀ọ̀dù rẹ.

curl -X PATCH https://api.zinndigital.com/v1/agency/boards/{boardId}/automations/{ruleId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string>, "trigger": <string> }'

Ṣé o ti wọlé? Iwọ̀n api ní nú ìgbékalẹ̀ rẹ kún id àjọ gidi rẹ ati bọtini tirẹ, o si nṣiṣẹ ibeere na lòdì si api gidi ki o le rii esi gidi na. Ṣí ojú abáná yìí sílẹ̀ nínú kọnsólù API

Àwọn kúlẹ̀kúlẹ̀

The WHOLE rule is re-validated, not just the changed fields — a change to the trigger alone can invalidate an action that was fine before it. ⛔ `suspended` is not settable. That status means *we* paused the rule after repeated failure and carries a reason the customer has not read; letting it be written would make our decision indistinguishable from theirs. Re-enabling a suspended rule clears its failure count.

Àwọn ìpìlẹ̀

Orúkọ	Iru	Tí a nílò	Kini o jẹ
`boardId (path)`	`Uuid`	Bẹẹni	Project board ID (UUIDv7).
`ruleId (path)`	`Uuid`	Bẹẹni	Automation rule ID (UUIDv7).

Akoonu ibeere naa

Orúkọ	Iru	Tí a nílò	Kini o jẹ
`name`	`string`	Bẹẹni	—
`description`	`string`	Bẹẹkọ	—
`trigger`	`string`	Bẹẹni	—
`trigger_config`	`object`	Bẹẹkọ	Per-trigger settings, e.g. `hours_before` for "due date approaching".
`conditions`	`BoardAutomationCondition[]`	Bẹẹkọ	ANDed. An empty list means the rule always matches its trigger.
`actions`	`BoardAutomationAction[]`	Bẹẹkọ	—
`status`	`string<enabled, disabled>`	Bẹẹkọ	—
`position`	`integer`	Bẹẹkọ	—

Idahun

Orúkọ	Iru	Tí a nílò	Kini o jẹ
`id`	`Uuid`	Bẹẹni	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Bẹẹni	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Bẹẹni	—
`description`	`string`	Bẹẹkọ	—
`trigger`	`string`	Bẹẹni	—
`trigger_config`	`object`	Bẹẹkọ	—
`conditions`	`BoardAutomationCondition[]`	Bẹẹkọ	—
`actions`	`BoardAutomationAction[]`	Bẹẹkọ	—
`status`	`BoardAutomationStatus`	Bẹẹni	`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`	Bẹẹkọ	—
`run_count`	`integer`	Bẹẹkọ	—
`fired_count`	`integer`	Bẹẹkọ	—
`consecutive_failures`	`integer`	Bẹẹkọ	—
`suspended_reason`	`string`	Bẹẹkọ	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`	Bẹẹkọ	—
`last_fired_at`	`string`	Bẹẹkọ	—
`last_run_at`	`string`	Bẹẹkọ	—
`next_due_at`	`string`	Bẹẹkọ	Only set for a wall-clock rule. Null for a rule on a live act.
`created_at`	`string`	Bẹẹkọ	—
`updated_at`	`string`	Bẹẹkọ	—

Awọn aṣiṣe ti ibudo ipari yii le da pada

401 · 403 · 404 · 422

PATCH /v1/agency/boards/{boardId}/automations/{ruleId}