agency-board
PATCH /v1/agency/boards/{boardId}/automations/{ruleId}
Change a rule, or pause and resume it.
ማረጋገጫ
የኤፒአይ ቁልፍ (API key) እንደ ቢረር ቶከን (bearer token) ይላኩ። ይህ የመጨረሻ ነጥብ (endpoint) በመግለጫው ውስጥ የተወሰነ ፈቃድ አልገለጸም፣ ስለዚህ ከማሰብ ይልቅ ለቁልፍዎ የሚያስፈልገውን አነስተኛ ፈቃድ ይስጡት እና ምላሹን ያረጋግጡ።
ይህ ኤንድፖይ መክፈቻ (endpoint) የድርጅት መታወቂያ (organisation id) አይወስድም። የእርስዎ ቁልፍ (key) እሱ የሚመለከተውን ድርጅት አስቀድሞ ይለያል፣ እና ምላሹም ለዚሁ የተወሰነ ነው።
ሞክሩት
በቅንፍ ውስጥ ያለውን ማንኛውንም ነገር በራስዎ እሴቶች ይተኩ፣ እና ቁልፍ ቦታ ያዢውን ከዳሽቦርድዎ በመጣ ቁልፍ ይተኩ።
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