agency-board

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

Change a rule, or pause and resume it.

Kimlik Doğrulama

Bir API anahtarını bearer token olarak gönderin. Bu uç nokta, teknik özelliklerde belirli bir yetki belirtmemektedir; bu nedenle, varsaymak yerine anahtarınıza ihtiyaç duyduğu en az yetkiyi verin ve yanıtı kontrol edin.

Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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.

Parametreler

Ad	Tür	Zorunlu	Ne olduğu
`boardId (path)`	`Uuid`	Evet	Project board ID (UUIDv7).
`ruleId (path)`	`Uuid`	Evet	Automation rule ID (UUIDv7).

İstek gövdesi

Ad	Tür	Zorunlu	Ne olduğu
`name`	`string`	Evet	—
`description`	`string`	Hayır	—
`trigger`	`string`	Evet	—
`trigger_config`	`object`	Hayır	Per-trigger settings, e.g. `hours_before` for "due date approaching".
`conditions`	`BoardAutomationCondition[]`	Hayır	ANDed. An empty list means the rule always matches its trigger.
`actions`	`BoardAutomationAction[]`	Hayır	—
`status`	`string<enabled, disabled>`	Hayır	—
`position`	`integer`	Hayır	—

Yanıt

Ad	Tür	Zorunlu	Ne olduğu
`id`	`Uuid`	Evet	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Evet	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Evet	—
`description`	`string`	Hayır	—
`trigger`	`string`	Evet	—
`trigger_config`	`object`	Hayır	—
`conditions`	`BoardAutomationCondition[]`	Hayır	—
`actions`	`BoardAutomationAction[]`	Hayır	—
`status`	`BoardAutomationStatus`	Evet	`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`	Hayır	—
`run_count`	`integer`	Hayır	—
`fired_count`	`integer`	Hayır	—
`consecutive_failures`	`integer`	Hayır	—
`suspended_reason`	`string`	Hayır	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`	Hayır	—
`last_fired_at`	`string`	Hayır	—
`last_run_at`	`string`	Hayır	—
`next_due_at`	`string`	Hayır	Only set for a wall-clock rule. Null for a rule on a live act.
`created_at`	`string`	Hayır	—
`updated_at`	`string`	Hayır	—

Bu uç noktanın dönderebileceği hatalar

401 · 403 · 404 · 422

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