agency-board

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

Change a rule, or pause and resume it.

Autenticación

Envía una clave de API como token de portador. Este endpoint no especifica un permiso concreto en la especificación, así que otorga a tu clave los mínimos privilegios necesarios y comprueba la respuesta en lugar de dar por sentado.

Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.

Pruébalo

Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.

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

¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API

Detalles

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.

Parámetros

Nombre	Tipo	Obligatorio	¿Qué es esto?
`boardId (path)`	`Uuid`	Sí	Project board ID (UUIDv7).
`ruleId (path)`	`Uuid`	Sí	Automation rule ID (UUIDv7).

Cuerpo de la solicitud

Nombre	Tipo	Obligatorio	¿Qué es esto?
`name`	`string`	Sí	—
`description`	`string`	No	—
`trigger`	`string`	Sí	—
`trigger_config`	`object`	No	Per-trigger settings, e.g. `hours_before` for "due date approaching".
`conditions`	`BoardAutomationCondition[]`	No	ANDed. An empty list means the rule always matches its trigger.
`actions`	`BoardAutomationAction[]`	No	—
`status`	`string<enabled, disabled>`	No	—
`position`	`integer`	No	—

Respuesta

Nombre	Tipo	Obligatorio	¿Qué es esto?
`id`	`Uuid`	Sí	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Sí	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Sí	—
`description`	`string`	No	—
`trigger`	`string`	Sí	—
`trigger_config`	`object`	No	—
`conditions`	`BoardAutomationCondition[]`	No	—
`actions`	`BoardAutomationAction[]`	No	—
`status`	`BoardAutomationStatus`	Sí	`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`	No	—
`run_count`	`integer`	No	—
`fired_count`	`integer`	No	—
`consecutive_failures`	`integer`	No	—
`suspended_reason`	`string`	No	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`	No	—
`last_fired_at`	`string`	No	—
`last_run_at`	`string`	No	—
`next_due_at`	`string`	No	Only set for a wall-clock rule. Null for a rule on a live act.
`created_at`	`string`	No	—
`updated_at`	`string`	No	—

Errores que este endpoint puede devolver

401 · 403 · 404 · 422

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