agency-board
PATCH /v1/agency/boards/{boardId}/automations/{ruleId}
Change a rule, or pause and resume it.
Xaqiijinta aqoonsiga
U dir fure API ahaan calaamad muujisa (bearer token). Barta dhammaadka ee kani ma caysino luqad ahaan oggolaansho gaar ah oo ku dhex jirta qeexidda, markaa sii furahaaga inta ugu yar ee uu u baahan yahay oo fiiri jawaabta halka aad wax ka qaadan lahayd.
Boggan ma qaato aqoonsiga ururka. Furahaagu wuxuu horay u aqoonsanayaa ururka uu ka tirsan yahay, jawaabtuna waxay ku kooban tahay halkaas.
Isku day
Ku beddel wax kasta oo ku dhex jira qeebaha xaglaha ah qiimayaashaada, sidoo kalena haystaaha furaha ku beddel fure ka dhex muuqda dashboordigaaga.
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> }'Ma sign-garaysay? Qalabka API ee ku jira dashboard-kaagu wuxuu buuxiyaa aqoonsigaaga ururka ee dhabta ah iyo furahaaga gaarka ah, wuxuuna ku shaqeysiiyaa codsiga API-ga nool si aad u aragto jawaabta dhabta ah. Kani ka fur barta kontoroolka ee API
Details
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.
Cabiraha
| Magaca | Nooc | Loo baahan yahay | Maxay tahay |
|---|---|---|---|
boardId (path) | Uuid | Haa | Project board ID (UUIDv7). |
ruleId (path) | Uuid | Haa | Automation rule ID (UUIDv7). |
Codsiga jidhkiisa
| Magaca | Nooc | Loo baahan yahay | Maxay tahay |
|---|---|---|---|
name | string | Haa | — |
description | string | Maya | — |
trigger | string | Haa | — |
trigger_config | object | Maya | Per-trigger settings, e.g. `hours_before` for "due date approaching". |
conditions | BoardAutomationCondition[] | Maya | ANDed. An empty list means the rule always matches its trigger. |
actions | BoardAutomationAction[] | Maya | — |
status | string<enabled, disabled> | Maya | — |
position | integer | Maya | — |
Jawaab
| Magaca | Nooc | Loo baahan yahay | Maxay tahay |
|---|---|---|---|
id | Uuid | Haa | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Haa | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Haa | — |
description | string | Maya | — |
trigger | string | Haa | — |
trigger_config | object | Maya | — |
conditions | BoardAutomationCondition[] | Maya | — |
actions | BoardAutomationAction[] | Maya | — |
status | BoardAutomationStatus | Haa | `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 | Maya | — |
run_count | integer | Maya | — |
fired_count | integer | Maya | — |
consecutive_failures | integer | Maya | — |
suspended_reason | string | Maya | 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 | Maya | — |
last_fired_at | string | Maya | — |
last_run_at | string | Maya | — |
next_due_at | string | Maya | Only set for a wall-clock rule. Null for a rule on a live act. |
created_at | string | Maya | — |
updated_at | string | Maya | — |
Cilladaha ay bartaani soo celin karto
401 · 403 · 404 · 422