agency-board

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

Change a rule, or pause and resume it.

Баталгаажуулалт

API түлхүүрийг bearer token хэлбэрээр илгөэнэ үү. Энэхүү төгсгөлийн цэг нь тодорхойлолтдоо тодорхой зөвшөөрлийг заагаагүй тул түлхүүрээрээ шаардагдах хамгийн бага эрхийг өгч, таамаглахаас илүүтэйгээр хариуг шалгана уу.

Энэ төгсгөл цэг нь ямар ч байгууллагын ID шаардахгүй. Таны түлхүүр аль хэдийн харьяалагдах байгууллагыг тодорхойлж байгаа бөгөөд хариу нь тухайн байгууллагын хүрээнд хязгаарлагдана.

Туршиж үзэх

Өнцөг хаалтанд байгаа бүх зүйлийг өөрийн утгаар солиж, түлхүүр санамж байрлуулагчийг хяналтын самбарынхаа түлхүүрээр сольж оруулна уу.

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

Та нэвтэрсэн байна уу? Таны хяналтын самбар дахь API консол нь таны бодит байгууллагын ID болон өөрийн түлхүүрийг автоматаар бөглөж, шууд ажиллаж буй API рүү хүсэлт илгээх тул та бодит хариуг харах боломжтой болно. Энэ төгсгөлийн цэгийг API консол дээр нээх

Дэлгэрэнгүй

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.

Параметрүүд

Нэр	Төрөл	Заавал шаардлагатай	Энэ юу вэ
`boardId (path)`	`Uuid`	Тийм	Project board ID (UUIDv7).
`ruleId (path)`	`Uuid`	Тийм	Automation rule ID (UUIDv7).

Хүсэлтийн бие

Нэр	Төрөл	Заавал шаардлагатай	Энэ юу вэ
`name`	`string`	Тийм	—
`description`	`string`	Үгүй	—
`trigger`	`string`	Тийм	—
`trigger_config`	`object`	Үгүй	Per-trigger settings, e.g. `hours_before` for "due date approaching".
`conditions`	`BoardAutomationCondition[]`	Үгүй	ANDed. An empty list means the rule always matches its trigger.
`actions`	`BoardAutomationAction[]`	Үгүй	—
`status`	`string<enabled, disabled>`	Үгүй	—
`position`	`integer`	Үгүй	—

Хариу үйлдэл

Нэр	Төрөл	Заавал шаардлагатай	Энэ юу вэ
`id`	`Uuid`	Тийм	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Тийм	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Тийм	—
`description`	`string`	Үгүй	—
`trigger`	`string`	Тийм	—
`trigger_config`	`object`	Үгүй	—
`conditions`	`BoardAutomationCondition[]`	Үгүй	—
`actions`	`BoardAutomationAction[]`	Үгүй	—
`status`	`BoardAutomationStatus`	Тийм	`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`	Үгүй	—
`run_count`	`integer`	Үгүй	—
`fired_count`	`integer`	Үгүй	—
`consecutive_failures`	`integer`	Үгүй	—
`suspended_reason`	`string`	Үгүй	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`	Үгүй	—
`last_fired_at`	`string`	Үгүй	—
`last_run_at`	`string`	Үгүй	—
`next_due_at`	`string`	Үгүй	Only set for a wall-clock rule. Null for a rule on a live act.
`created_at`	`string`	Үгүй	—
`updated_at`	`string`	Үгүй	—

Энэ төгсгөл цэгээс буцааж болох алдаанууд

401 · 403 · 404 · 422

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