agency-board

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

Change a rule, or pause and resume it.

Uthibitishaji

Tuma ufunguo wa API kama tokeni ya kubeba. Sehemu hii ya mwisho haitaji ruhusa maalum katika maelezo, kwa hivyo ipe ufunguo wako kiwango cha chini kabisa kinachohitajika na uangalie jibu badala ya kukisia.

Endpoint hii haichukui kitambulisho cha shirika. Ufunguo wako tayari unalitambua shirika linalohusika, na jibu limewekewa kikomo kwa shirika hilo pekee.

Jaribu

Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.

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

Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API

Maelezo

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.

Vigezo

Jina	Aina	Inayohitajika	Kilicho hiki
`boardId (path)`	`Uuid`	Ndiyo	Project board ID (UUIDv7).
`ruleId (path)`	`Uuid`	Ndiyo	Automation rule ID (UUIDv7).

Mwili wa ombi

Jina	Aina	Inayohitajika	Kilicho hiki
`name`	`string`	Ndiyo	—
`description`	`string`	Hapana	—
`trigger`	`string`	Ndiyo	—
`trigger_config`	`object`	Hapana	Per-trigger settings, e.g. `hours_before` for "due date approaching".
`conditions`	`BoardAutomationCondition[]`	Hapana	ANDed. An empty list means the rule always matches its trigger.
`actions`	`BoardAutomationAction[]`	Hapana	—
`status`	`string<enabled, disabled>`	Hapana	—
`position`	`integer`	Hapana	—

Majibu

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

Hitilafu ambazo mwisho huu unaweza kurudisha

401 · 403 · 404 · 422

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