agency-board

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

Change a rule, or pause and resume it.

การยืนยันตัวตน

ส่ง API key เป็น bearer token เอนด์พอยต์นี้ไม่ได้ระบุสิทธิ์การใช้งานเฉพาะในข้อกำหนด ดังนั้นควรให้คีย์ของคุณมีสิทธิ์น้อยที่สุดเท่าที่จำเป็นและให้ตรวจสอบจากการตอบกลับแทนที่จะคาดเดา

ปลายทางนี้ไม่ต้องใช้รหัสองค์กร คีย์ของคุณระบุองค์กรที่เป็นเจ้าของอยู่แล้ว และการตอบกลับจะถูกจำกัดขอบเขตไว้เฉพาะองค์กรนั้น

ทดลองใช้เลย

แทนที่สิ่งใดๆ ที่อยู่ภายในวงเล็บแหลมด้วยค่าของคุณเอง และตัวยึดตำแหน่งคีย์ด้วยคีย์จากแดชบอร์ดของคุณ

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}