agency-board

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

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

सबै agency-board इन्डपइन्टहरू

प्रमाणीकरण

एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। यो इन्डपोइन्टले विशिष्ट अनुमति खुलाएको छैन, त्यसैले अनुमान गर्नुको सट्टा आफ्नो कुञ्जीलाई आवश्यक पर्ने न्यूनतम अधिकार दिनुहोस् र प्रतिक्रिया जाँच गर्नुहोस्।

यो इन्डपोइन्टले कुनै संस्थाको आइडी लिँदैन। तपाईंको कुञ्जीले यस अन्तर्गत पर्ने संस्थालाई पहिल्यै पहिचान गर्छ, र प्रतिक्रिया त्यसैमा सीमित हुन्छ।

प्रयास गर्नुहोस्

कोणीय कोष्ठकभित्र भएका जुनसुकै कुरालाई आफ्नो मानहरूद्वारा बदल्नुहोस्, र मुख्य स्थानहोल्डरलाई तपाईंको ड्यासबोर्डको कुञ्जीद्वारा बदल्नुहोस्।

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

लगइन गर्नुभएको छ? तपाईंको ड्यासबोर्डमा रहेको API कन्सोलले तपाईंको वास्तविक संस्थाको आईडी र आफ्नै कुञ्जी भरिदिन्छ, र लाइभ API विरुद्ध अनुरोध चलाउँछ ताकि तपाईंले वास्तविक प्रतिक्रिया हेर्न सक्नुहोस्। यो एन्डपोइन्टलाई API कन्सोलमा खोल्नुहोस्

विवरणहरू

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.

प्यारामिटरहरू

नामप्रकारआवश्यकयो के हो
boardId (path)Uuidहुन्छProject board ID (UUIDv7).

अनुरोध बडी

नामप्रकारआवश्यकयो के हो
namestringहुन्छ
descriptionstringहैन
triggerstringहुन्छ
trigger_configobjectहैनPer-trigger settings, e.g. `hours_before` for "due date approaching".
conditionsBoardAutomationCondition[]हैनANDed. An empty list means the rule always matches its trigger.
actionsBoardAutomationAction[]हैन
statusstring<enabled, disabled>हैन
positionintegerहैन

प्रतिक्रिया

नामप्रकारआवश्यकयो के हो
idUuidहुन्छUUIDv7 identifier — sortable by creation time (docs/02 §8).
board_idUuidहुन्छUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringहुन्छ
descriptionstringहैन
triggerstringहुन्छ
trigger_configobjectहैन
conditionsBoardAutomationCondition[]हैन
actionsBoardAutomationAction[]हैन
statusBoardAutomationStatusहुन्छ`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…
positionintegerहैन
run_countintegerहैन
fired_countintegerहैन
consecutive_failuresintegerहैन
suspended_reasonstringहैन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_atstringहैन
last_fired_atstringहैन
last_run_atstringहैन
next_due_atstringहैनOnly set for a wall-clock rule. Null for a rule on a live act.
created_atstringहैन
updated_atstringहैन

यो इन्डपोइन्टले फर्काउन सक्ने त्रुटिहरू

401 · 403 · 404 · 422