agency-board

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

Change a rule, or pause and resume it.

Xác thực

Gửi khóa API dưới dạng mã thông báo bearer. Điểm cuối này không nêu rõ quyền cụ thể trong thông số kỹ thuật, vì vậy hãy cấp cho khóa của bạn quyền tối thiểu cần thiết và kiểm tra phản hồi thay vì phỏng đoán.

Endpoint này không nhận ID tổ chức. Khóa của bạn đã xác định tổ chức mà nó thuộc về và phản hồi được giới hạn trong phạm vi đó.

Dùng thử

Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.

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

Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API

Chi tiết

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.

Tham số

Tên	Loại	Bắt buộc	Nội dung này là gì
`boardId (path)`	`Uuid`	Có	Project board ID (UUIDv7).
`ruleId (path)`	`Uuid`	Có	Automation rule ID (UUIDv7).

Nội dung yêu cầu

Tên	Loại	Bắt buộc	Nội dung này là gì
`name`	`string`	Có	—
`description`	`string`	Không	—
`trigger`	`string`	Có	—
`trigger_config`	`object`	Không	Per-trigger settings, e.g. `hours_before` for "due date approaching".
`conditions`	`BoardAutomationCondition[]`	Không	ANDed. An empty list means the rule always matches its trigger.
`actions`	`BoardAutomationAction[]`	Không	—
`status`	`string<enabled, disabled>`	Không	—
`position`	`integer`	Không	—

Phản hồi

Tên	Loại	Bắt buộc	Nội dung này là gì
`id`	`Uuid`	Có	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Có	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Có	—
`description`	`string`	Không	—
`trigger`	`string`	Có	—
`trigger_config`	`object`	Không	—
`conditions`	`BoardAutomationCondition[]`	Không	—
`actions`	`BoardAutomationAction[]`	Không	—
`status`	`BoardAutomationStatus`	Có	`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`	Không	—
`run_count`	`integer`	Không	—
`fired_count`	`integer`	Không	—
`consecutive_failures`	`integer`	Không	—
`suspended_reason`	`string`	Không	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`	Không	—
`last_fired_at`	`string`	Không	—
`last_run_at`	`string`	Không	—
`next_due_at`	`string`	Không	Only set for a wall-clock rule. Null for a rule on a live act.
`created_at`	`string`	Không	—
`updated_at`	`string`	Không	—

Các lỗi điểm cuối này có thể trả về

401 · 403 · 404 · 422

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