agency-board

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

Change a rule, or pause and resume it.

Tabbatar da Asali

Aiko da maɓallin API a matsayin bearer token. Wannan ma'anar ba ta bayyana takamaiman izini ba a cikin ƙayyadaddun bayanai, don haka ba wa maɓallin ku mafi ƙarancin abin da yake buƙata kuma ku bincika amsar maimakon yin zato.

Wannan wurin ƙarewa ba ya buƙatar ID na ƙungiya. Maɓallin ku ya riga ya gano ƙungiyar da yake ciki, kuma an iyakance amsa a kanta.

Gwada

May gurbin komai da ke cikin kusurwa da ƙimar ka, kuma may gurbin maballi da maballi daga allon sarrafa ka.

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

An shiga? Na'urar sarrafa API da ke cikin sashin kulawarka tana cika ainihin lambar ƙungiyarka da maɓallinka naka, sannan tana gudanar da buƙatar a kan ainihin API don haka zaka iya ganin amsar gaske. Buɗe wannan tashar a cikin na'urar kula da API

Bayani

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.

Sigogi

Suna	Nau'i	Ana buƙata	Abin da yake
`boardId (path)`	`Uuid`	Eh	Project board ID (UUIDv7).
`ruleId (path)`	`Uuid`	Eh	Automation rule ID (UUIDv7).

Jikin buƙata

Suna	Nau'i	Ana buƙata	Abin da yake
`name`	`string`	Eh	—
`description`	`string`	A'a	—
`trigger`	`string`	Eh	—
`trigger_config`	`object`	A'a	Per-trigger settings, e.g. `hours_before` for "due date approaching".
`conditions`	`BoardAutomationCondition[]`	A'a	ANDed. An empty list means the rule always matches its trigger.
`actions`	`BoardAutomationAction[]`	A'a	—
`status`	`string<enabled, disabled>`	A'a	—
`position`	`integer`	A'a	—

Martani

Suna	Nau'i	Ana buƙata	Abin da yake
`id`	`Uuid`	Eh	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Eh	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Eh	—
`description`	`string`	A'a	—
`trigger`	`string`	Eh	—
`trigger_config`	`object`	A'a	—
`conditions`	`BoardAutomationCondition[]`	A'a	—
`actions`	`BoardAutomationAction[]`	A'a	—
`status`	`BoardAutomationStatus`	Eh	`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`	A'a	—
`run_count`	`integer`	A'a	—
`fired_count`	`integer`	A'a	—
`consecutive_failures`	`integer`	A'a	—
`suspended_reason`	`string`	A'a	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`	A'a	—
`last_fired_at`	`string`	A'a	—
`last_run_at`	`string`	A'a	—
`next_due_at`	`string`	A'a	Only set for a wall-clock rule. Null for a rule on a live act.
`created_at`	`string`	A'a	—
`updated_at`	`string`	A'a	—

Kuskuren da wannan matsaya za ta iya maido wa

401 · 403 · 404 · 422

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