agency-board

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

Change a rule, or pause and resume it.

身份验证

请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限，因此请为您的密钥赋予所需的最小权限，并通过检查响应来确认，而不是盲目假设。

此端点不需要组织 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}