agency-board

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

Change a rule, or pause and resume it.

Doğrulama

API açarını bearer token kimi göndərin. Bu səhifə spresifikasiyada xüsusi icazə tələb etmir, buna görə də açarınıza ehtiyac duyduğu minimum səviyyədə icazə verin və güman etmək əvəzinə cavabı yoxlayın.

Bu endpoint heç bir təşkilat ID-si tələb etmir. Sizin açarınız artıq aid olduğu təşkilatı müəyyən edir və cavab həmin təşkilat üçün məhdudlaşdırılır.

Sınaqdan keçir

Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.

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

Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın

Təfərrüatlar

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.

Parametrlər

Ad	Tip	Tələb olunur	Nədir
`boardId (path)`	`Uuid`	Bəli	Project board ID (UUIDv7).
`ruleId (path)`	`Uuid`	Bəli	Automation rule ID (UUIDv7).

Sorğu gövdəsi

Ad	Tip	Tələb olunur	Nədir
`name`	`string`	Bəli	—
`description`	`string`	Xeyr	—
`trigger`	`string`	Bəli	—
`trigger_config`	`object`	Xeyr	Per-trigger settings, e.g. `hours_before` for "due date approaching".
`conditions`	`BoardAutomationCondition[]`	Xeyr	ANDed. An empty list means the rule always matches its trigger.
`actions`	`BoardAutomationAction[]`	Xeyr	—
`status`	`string<enabled, disabled>`	Xeyr	—
`position`	`integer`	Xeyr	—

Cavab

Ad	Tip	Tələb olunur	Nədir
`id`	`Uuid`	Bəli	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Bəli	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Bəli	—
`description`	`string`	Xeyr	—
`trigger`	`string`	Bəli	—
`trigger_config`	`object`	Xeyr	—
`conditions`	`BoardAutomationCondition[]`	Xeyr	—
`actions`	`BoardAutomationAction[]`	Xeyr	—
`status`	`BoardAutomationStatus`	Bəli	`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`	Xeyr	—
`run_count`	`integer`	Xeyr	—
`fired_count`	`integer`	Xeyr	—
`consecutive_failures`	`integer`	Xeyr	—
`suspended_reason`	`string`	Xeyr	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`	Xeyr	—
`last_fired_at`	`string`	Xeyr	—
`last_run_at`	`string`	Xeyr	—
`next_due_at`	`string`	Xeyr	Only set for a wall-clock rule. Null for a rule on a live act.
`created_at`	`string`	Xeyr	—
`updated_at`	`string`	Xeyr	—

Bu son nöqtənin qaytara biləcəyi xətalar

401 · 403 · 404 · 422

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