agency-board

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

Change a rule, or pause and resume it.

සත්‍යාපනය

බෙරර් ටෝකනයක් ලෙස API යතුරක් යවන්න. මෙම අන්ත ලක්ෂ්‍යය පිරිවිතරයේ නිශ්චිත අවසරයක් දක්වා නැත, එබැවින් උපකල්පනය කරනවාට වඩා ඔබේ යතුරට අවශ්‍ය අවම අවසරය ලබා දී ප්‍රතිචාරය පරීක්ෂා කරන්න.

මෙම අවසාන ලක්ෂ්‍යය සඳහා සංවිධාන හැඳුනුම්පතක් (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 කොන්සෝලය මඟින් ඔබේ සැබෑ ආයතනික හැඳුනුම්පත සහ ඔබේම යතුර පුරවා, සජීවී 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`	නැත	—

පsspil

නම	වර්ගය	අත්‍යවශ්‍යයි	එය කුමක්ද
`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}