agency-board

POST `/v1/agency/boards/{boardId}/automations`

Create a rule — when this happens, only if that, then do these.

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.

Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/automations \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string>, "trigger": <string> }'

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

Validated against the catalogue at save time, not at run time. A rule pairing a card action with a trigger that carries no card, naming a context field its trigger does not publish, or using an operator the field's type cannot take is refused here with the offending clause named — because the alternative is a rule that sits in the list looking enabled and does nothing for ever, whose only evidence is an absence.

Parameter

Name	Typ	Erforderlich	Was es ist
`boardId (path)`	`Uuid`	Ja	Project board ID (UUIDv7).

Anfragekörper

Name	Typ	Erforderlich	Was es ist
`name`	`string`	Ja	—
`description`	`string`	Nein	—
`trigger`	`string`	Ja	—
`trigger_config`	`object`	Nein	Per-trigger settings, e.g. `hours_before` for "due date approaching".
`conditions`	`BoardAutomationCondition[]`	Nein	ANDed. An empty list means the rule always matches its trigger.
`actions`	`BoardAutomationAction[]`	Nein	—
`status`	`string<enabled, disabled>`	Nein	—
`position`	`integer`	Nein	—

Antwort

Name	Typ	Erforderlich	Was es ist
`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`	Nein	—
`trigger`	`string`	Ja	—
`trigger_config`	`object`	Nein	—
`conditions`	`BoardAutomationCondition[]`	Nein	—
`actions`	`BoardAutomationAction[]`	Nein	—
`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`	Nein	—
`run_count`	`integer`	Nein	—
`fired_count`	`integer`	Nein	—
`consecutive_failures`	`integer`	Nein	—
`suspended_reason`	`string`	Nein	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`	Nein	—
`last_fired_at`	`string`	Nein	—
`last_run_at`	`string`	Nein	—
`next_due_at`	`string`	Nein	Only set for a wall-clock rule. Null for a rule on a live act.
`created_at`	`string`	Nein	—
`updated_at`	`string`	Nein	—

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 422

POST /v1/agency/boards/{boardId}/automations