agency-board

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

Change a rule, or pause and resume it.

Authenticatie

Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.

Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

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> }'

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

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.

Parameters

Naam	Type	Verplicht	Wat dit is
`boardId (path)`	`Uuid`	Ja	Project board ID (UUIDv7).
`ruleId (path)`	`Uuid`	Ja	Automation rule ID (UUIDv7).

Aanvraaglichaam

Naam	Type	Verplicht	Wat dit is
`name`	`string`	Ja	—
`description`	`string`	Nee	—
`trigger`	`string`	Ja	—
`trigger_config`	`object`	Nee	Per-trigger settings, e.g. `hours_before` for "due date approaching".
`conditions`	`BoardAutomationCondition[]`	Nee	ANDed. An empty list means the rule always matches its trigger.
`actions`	`BoardAutomationAction[]`	Nee	—
`status`	`string<enabled, disabled>`	Nee	—
`position`	`integer`	Nee	—

Reactie

Naam	Type	Verplicht	Wat dit is
`id`	`Uuid`	Ja	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Ja	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Ja	—
`description`	`string`	Nee	—
`trigger`	`string`	Ja	—
`trigger_config`	`object`	Nee	—
`conditions`	`BoardAutomationCondition[]`	Nee	—
`actions`	`BoardAutomationAction[]`	Nee	—
`status`	`BoardAutomationStatus`	Ja	`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`	Nee	—
`run_count`	`integer`	Nee	—
`fired_count`	`integer`	Nee	—
`consecutive_failures`	`integer`	Nee	—
`suspended_reason`	`string`	Nee	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`	Nee	—
`last_fired_at`	`string`	Nee	—
`last_run_at`	`string`	Nee	—
`next_due_at`	`string`	Nee	Only set for a wall-clock rule. Null for a rule on a live act.
`created_at`	`string`	Nee	—
`updated_at`	`string`	Nee	—

Fouten die dit eindpunt kan retourneren

401 · 403 · 404 · 422

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