agency-board

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

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

Tüm agency-board uç noktaları

Kimlik Doğrulama

Bir API anahtarını bearer token olarak gönderin. Bu uç nokta, teknik özelliklerde belirli bir yetki belirtmemektedir; bu nedenle, varsaymak yerine anahtarınıza ihtiyaç duyduğu en az yetkiyi verin ve yanıtı kontrol edin.

Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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.

Parametreler

AdTürZorunluNe olduğu
boardId (path)UuidEvetProject board ID (UUIDv7).

İstek gövdesi

AdTürZorunluNe olduğu
namestringEvet
descriptionstringHayır
triggerstringEvet
trigger_configobjectHayırPer-trigger settings, e.g. `hours_before` for "due date approaching".
conditionsBoardAutomationCondition[]HayırANDed. An empty list means the rule always matches its trigger.
actionsBoardAutomationAction[]Hayır
statusstring<enabled, disabled>Hayır
positionintegerHayır

Yanıt

AdTürZorunluNe olduğu
idUuidEvetUUIDv7 identifier — sortable by creation time (docs/02 §8).
board_idUuidEvetUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringEvet
descriptionstringHayır
triggerstringEvet
trigger_configobjectHayır
conditionsBoardAutomationCondition[]Hayır
actionsBoardAutomationAction[]Hayır
statusBoardAutomationStatusEvet`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…
positionintegerHayır
run_countintegerHayır
fired_countintegerHayır
consecutive_failuresintegerHayır
suspended_reasonstringHayırWhy 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_atstringHayır
last_fired_atstringHayır
last_run_atstringHayır
next_due_atstringHayırOnly set for a wall-clock rule. Null for a rule on a live act.
created_atstringHayır
updated_atstringHayır

Bu uç noktanın dönderebileceği hatalar

401 · 403 · 404 · 422