agency-board

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

Change a rule, or pause and resume it.

Санҷиши ҳаққоният

Kalitи API-ро ҳамчун token-и bearer фиристед. Ин нуқтаи ниҳоӣ дар мушаххасот иҷозати мушаххасеро нишон намедиҳад, бинобар ин ба калиди худ ҳадди ақали заруриро диҳед ва ба ҷои тахмин кардан, ҷавобро санҷед.

Ин нуқтаи поёнӣ ягон рақами мушаххаси созмонро талаб намекунад. Калиди шумо аллакай созмонеро, ки ба он тааллуқ дорад, муайян мекунад ва ҷавоб ба он маҳдуд карда мешавад.

Санҷидан

Ҳар чизро дар қаavски кунҷӣ бо қиматҳои худ ва ҷойи нигоҳдорандаи калидро бо калима аз панели идоракунии худ иваз кунед.

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

Воarid шудаед? Консоли API дар панели идоракунии шумо рақами мушаххаси ташкилоти воқеӣ ва калиди худро пур мекунад ва дархостро бар зидди API-и фаъол иҷро мекунад, то шумо посухи воқеиро бубинед. Ин нуқтаи ниҳоиро дар консоли API кушоед

Тафсилот

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.

Параметрҳо

Ном	Намуд	Талаб карда мешавад	Ин чӣ аст
`boardId (path)`	`Uuid`	Бале	Project board ID (UUIDv7).
`ruleId (path)`	`Uuid`	Бале	Automation rule ID (UUIDv7).

Ҷисми дархост

Ном	Намуд	Талаб карда мешавад	Ин чӣ аст
`name`	`string`	Бале	—
`description`	`string`	Не	—
`trigger`	`string`	Бале	—
`trigger_config`	`object`	Не	Per-trigger settings, e.g. `hours_before` for "due date approaching".
`conditions`	`BoardAutomationCondition[]`	Не	ANDed. An empty list means the rule always matches its trigger.
`actions`	`BoardAutomationAction[]`	Не	—
`status`	`string<enabled, disabled>`	Не	—
`position`	`integer`	Не	—

Ҷавоб

Ном	Намуд	Талаб карда мешавад	Ин чӣ аст
`id`	`Uuid`	Бале	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Бале	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Бале	—
`description`	`string`	Не	—
`trigger`	`string`	Бале	—
`trigger_config`	`object`	Не	—
`conditions`	`BoardAutomationCondition[]`	Не	—
`actions`	`BoardAutomationAction[]`	Не	—
`status`	`BoardAutomationStatus`	Бале	`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`	Не	—
`run_count`	`integer`	Не	—
`fired_count`	`integer`	Не	—
`consecutive_failures`	`integer`	Не	—
`suspended_reason`	`string`	Не	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`	Не	—
`last_fired_at`	`string`	Не	—
`last_run_at`	`string`	Не	—
`next_due_at`	`string`	Не	Only set for a wall-clock rule. Null for a rule on a live act.
`created_at`	`string`	Не	—
`updated_at`	`string`	Не	—

Хатоҳое, ки ин нуқтаи ниҳоӣ метавонад баргардонад

401 · 403 · 404 · 422

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