agency-board
POST /v1/agency/boards/{boardId}/automations
Create a rule — when this happens, only if that, then do these.
אימות
שלח מפתח API כטוקן Bearer. נקודת קצה זו אינה מציינת הרשאת ספציפית במפרט, לכן הקצה למפתח שלך את המינימום הנדרש ובדוק את התגובה במקום להניח הנחות.
נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/automations \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string>, "trigger": <string> }'מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API
פרטים
Validated against the catalogue at save time, not at run time. A rule pairing a card action with a trigger that carries no card, naming a context field its trigger does not publish, or using an operator the field's type cannot take is refused here with the offending clause named — because the alternative is a rule that sits in the list looking enabled and does nothing for ever, whose only evidence is an absence.
פרמטרים
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
boardId (path) | Uuid | כן | Project board 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