agency-board

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

Change a rule, or pause and resume it.

Autentificare

Trimiteți o cheie API ca token de tip bearer. Acest punct final nu specifică o permisiune anume în specificație, așa că acordați cheii cele mai puține drepturi necesare și verificați răspunsul în loc să faceți presupuneri.

Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.

Încearcă

Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.

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

Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API

Detalii

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.

Parametri

Nume	Tip	Obligatoriu	Ce este
`boardId (path)`	`Uuid`	Da	Project board ID (UUIDv7).
`ruleId (path)`	`Uuid`	Da	Automation rule ID (UUIDv7).

Corp cerere

Nume	Tip	Obligatoriu	Ce este
`name`	`string`	Da	—
`description`	`string`	Nu	—
`trigger`	`string`	Da	—
`trigger_config`	`object`	Nu	Per-trigger settings, e.g. `hours_before` for "due date approaching".
`conditions`	`BoardAutomationCondition[]`	Nu	ANDed. An empty list means the rule always matches its trigger.
`actions`	`BoardAutomationAction[]`	Nu	—
`status`	`string<enabled, disabled>`	Nu	—
`position`	`integer`	Nu	—

Răspuns

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

Erori pe care le poate returna acest punct final

401 · 403 · 404 · 422

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