agency-board

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

Change a rule, or pause and resume it.

Autentifikatsiya

API kalitini bearer token sifatida yuboring. Ushbu yakuniy nuqta spetsifikatsiyada ma'lum bir ruxsatni ko'rsatmaydi, shuning uchun kalitingizga eng kam kerakli huquqni bering va taxmin qilish o'rniga javobni tekshiring.

Bu yakuniy nuqta hech qanday tashkilot identifikatorini qabul qilmaydi. Sizning kalitingiz unga tegishli tashkilotni allaqachon aniqlaydi va javob shunga qarab cheklanadi.

Sinab ko'rish

Qavslardagi har qanday narsani o'z qiymatlaringiz bilan, kalit pleysxolderini эsa boshqaruv panelingizdagi kalit bilan almashtiring.

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

Tizimga kirganmisiz? Boshqaruv panelingizdagi API konsoli haqiqiy tashkilot ID raqamingiz va shaxsiy kalitingizni avtomatik to'ldiradi hamda haqiqiy javobni ko'rishingiz uchun so'rovni jonli API orqali bajaradi. Ushbu yakuniy nuqtani API konsolida oching

Tafsilotlar

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.

Parametrlar

Nomi	Turi	Majburiy	Nima bu
`boardId (path)`	`Uuid`	Ha	Project board ID (UUIDv7).
`ruleId (path)`	`Uuid`	Ha	Automation rule ID (UUIDv7).

Soʻrov tanasi

Nomi	Turi	Majburiy	Nima bu
`name`	`string`	Ha	—
`description`	`string`	Yo'q	—
`trigger`	`string`	Ha	—
`trigger_config`	`object`	Yo'q	Per-trigger settings, e.g. `hours_before` for "due date approaching".
`conditions`	`BoardAutomationCondition[]`	Yo'q	ANDed. An empty list means the rule always matches its trigger.
`actions`	`BoardAutomationAction[]`	Yo'q	—
`status`	`string<enabled, disabled>`	Yo'q	—
`position`	`integer`	Yo'q	—

Javob

Nomi	Turi	Majburiy	Nima bu
`id`	`Uuid`	Ha	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Ha	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Ha	—
`description`	`string`	Yo'q	—
`trigger`	`string`	Ha	—
`trigger_config`	`object`	Yo'q	—
`conditions`	`BoardAutomationCondition[]`	Yo'q	—
`actions`	`BoardAutomationAction[]`	Yo'q	—
`status`	`BoardAutomationStatus`	Ha	`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`	Yo'q	—
`run_count`	`integer`	Yo'q	—
`fired_count`	`integer`	Yo'q	—
`consecutive_failures`	`integer`	Yo'q	—
`suspended_reason`	`string`	Yo'q	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`	Yo'q	—
`last_fired_at`	`string`	Yo'q	—
`last_run_at`	`string`	Yo'q	—
`next_due_at`	`string`	Yo'q	Only set for a wall-clock rule. Null for a rule on a live act.
`created_at`	`string`	Yo'q	—
`updated_at`	`string`	Yo'q	—

Ushbu yakuniy nuqta qaytarishi mumkin bo'lgan xatolar

401 · 403 · 404 · 422

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