agency-board

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

Change a rule, or pause and resume it.

Autentikasi

Kirimkan kunci API sebagai token bearer. Titik akhir ini tidak menyatakan izin tertentu dalam spesifikasi, jadi berikan kunci Anda izin minimum yang diperlukan dan periksa responsnya alih-alih berasumsi.

Endpoint ini tidak memerlukan id organisasi. Kunci Anda telah mengidentifikasi organisasi tempatnya berafiliasi, dan respons akan dibatasi untuk organisasi tersebut.

Coba

Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.

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

Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API

Detail

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.

Parameter

Nama	Jenis	Wajib	Tentang apa ini
`boardId (path)`	`Uuid`	Ya	Project board ID (UUIDv7).
`ruleId (path)`	`Uuid`	Ya	Automation rule ID (UUIDv7).

Isi permintaan

Nama	Jenis	Wajib	Tentang apa ini
`name`	`string`	Ya	—
`description`	`string`	Tidak	—
`trigger`	`string`	Ya	—
`trigger_config`	`object`	Tidak	Per-trigger settings, e.g. `hours_before` for "due date approaching".
`conditions`	`BoardAutomationCondition[]`	Tidak	ANDed. An empty list means the rule always matches its trigger.
`actions`	`BoardAutomationAction[]`	Tidak	—
`status`	`string<enabled, disabled>`	Tidak	—
`position`	`integer`	Tidak	—

Tanggapan

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

Kesalahan yang dapat dikembalikan oleh titik akhir ini

401 · 403 · 404 · 422

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