agency-board

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

Change a rule, or pause and resume it.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API) كرمز حامل (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

التفاصيل

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}