agency-board

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

Change a rule, or pause and resume it.

Аутентификация

API кілтін bearer токені ретінде жіберіңіз. Бұл соңғы нүкте сипаттамада арнайы рұқсатты көрсетпейді, сондықтан болжағаннан гөрі кілтіңізге қажетті ең аз рұқсатты беріп, жауапты тексеріңіз.

Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.

Әрекет етіп көру

Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.

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 консолі ұйымыңыздың нақты идентификаторы мен жеке кілтіңізді автоматты түрде толтырады да, нақты жауапты көре алуыңыз үшін сұрауды тікелей жұмыс істеп тұрған 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.

Параметрлер

Аты	Tүрі	Міндетті	Мазмұны
`boardId (path)`	`Uuid`	Иә	Project board ID (UUIDv7).
`ruleId (path)`	`Uuid`	Иә	Automation rule ID (UUIDv7).

Сұрау денесі

Аты	Tүрі	Міндетті	Мазмұны
`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`	Жоқ	—

Жауап

Аты	Tүрі	Міндетті	Мазмұны
`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}