agency-board

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

Change a rule, or pause and resume it.

Autentifikimi

Drgoni një çelës API si një token mbajtës. Ky pikëndalim nuk specifikon një leje specifike në specifikim, prandaj jepini çelësit tuaj minimumin e nevojshëm dhe kontrolloni përgjigjen në vend që të supozoni.

Ky pikëndalim nuk pranon id të organizatës. Çelësi juaj tashmë identifikon organizatën së cilës i përket dhe përgjigjja kufizohet vetëm për atë.

Provoje

Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.

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

Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së

Detajet

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.

Parametrat

Emri	Lloji	Kërkohet	Çfarë është kjo
`boardId (path)`	`Uuid`	Po	Project board ID (UUIDv7).
`ruleId (path)`	`Uuid`	Po	Automation rule ID (UUIDv7).

Trupi i kërkesës

Emri	Lloji	Kërkohet	Çfarë është kjo
`name`	`string`	Po	—
`description`	`string`	Jo	—
`trigger`	`string`	Po	—
`trigger_config`	`object`	Jo	Per-trigger settings, e.g. `hours_before` for "due date approaching".
`conditions`	`BoardAutomationCondition[]`	Jo	ANDed. An empty list means the rule always matches its trigger.
`actions`	`BoardAutomationAction[]`	Jo	—
`status`	`string<enabled, disabled>`	Jo	—
`position`	`integer`	Jo	—

Përgjigja

Emri	Lloji	Kërkohet	Çfarë është kjo
`id`	`Uuid`	Po	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Po	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Po	—
`description`	`string`	Jo	—
`trigger`	`string`	Po	—
`trigger_config`	`object`	Jo	—
`conditions`	`BoardAutomationCondition[]`	Jo	—
`actions`	`BoardAutomationAction[]`	Jo	—
`status`	`BoardAutomationStatus`	Po	`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`	Jo	—
`run_count`	`integer`	Jo	—
`fired_count`	`integer`	Jo	—
`consecutive_failures`	`integer`	Jo	—
`suspended_reason`	`string`	Jo	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`	Jo	—
`last_fired_at`	`string`	Jo	—
`last_run_at`	`string`	Jo	—
`next_due_at`	`string`	Jo	Only set for a wall-clock rule. Null for a rule on a live act.
`created_at`	`string`	Jo	—
`updated_at`	`string`	Jo	—

Gabimet që ky pikëndalim mund të kthejë

401 · 403 · 404 · 422

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