agency-board

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

Change a rule, or pause and resume it.

Pagpapatotoo

Magpadala ng API key bilang bearer token. Ang endpoint na ito ay hindi naglatag ng tiyak na pahintulot sa pagtutukoy, kaya ibigay sa iyong key ang pinakamababang kailangan nito at suriin ang tugon sa halip na umasa.

Ang endpoint na ito ay hindi nangangailangan ng id ng organisasyon. Natutukoy na ng iyong key ang organisasyong kinabibilangan nito, at nakatuon ang tugon dito.

Subukan ito

Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.

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> }'

Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API

Mga Detalye

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.

Mga Parameter

Pangalan	Uri	Kailangan	Ano ito
`boardId (path)`	`Uuid`	Oo	Project board ID (UUIDv7).
`ruleId (path)`	`Uuid`	Oo	Automation rule ID (UUIDv7).

Katawan ng kahilingan

Pangalan	Uri	Kailangan	Ano ito
`name`	`string`	Oo	—
`description`	`string`	Hindi	—
`trigger`	`string`	Oo	—
`trigger_config`	`object`	Hindi	Per-trigger settings, e.g. `hours_before` for "due date approaching".
`conditions`	`BoardAutomationCondition[]`	Hindi	ANDed. An empty list means the rule always matches its trigger.
`actions`	`BoardAutomationAction[]`	Hindi	—
`status`	`string<enabled, disabled>`	Hindi	—
`position`	`integer`	Hindi	—

Tugon

Pangalan	Uri	Kailangan	Ano ito
`id`	`Uuid`	Oo	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Oo	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Oo	—
`description`	`string`	Hindi	—
`trigger`	`string`	Oo	—
`trigger_config`	`object`	Hindi	—
`conditions`	`BoardAutomationCondition[]`	Hindi	—
`actions`	`BoardAutomationAction[]`	Hindi	—
`status`	`BoardAutomationStatus`	Oo	`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`	Hindi	—
`run_count`	`integer`	Hindi	—
`fired_count`	`integer`	Hindi	—
`consecutive_failures`	`integer`	Hindi	—
`suspended_reason`	`string`	Hindi	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`	Hindi	—
`last_fired_at`	`string`	Hindi	—
`last_run_at`	`string`	Hindi	—
`next_due_at`	`string`	Hindi	Only set for a wall-clock rule. Null for a rule on a live act.
`created_at`	`string`	Hindi	—
`updated_at`	`string`	Hindi	—

Mga error na maibabalik ng endpoint na ito

401 · 403 · 404 · 422

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