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.

پارامترها

نام	نوع	الزامی	چیست
`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}