agency-board

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

Change a rule, or pause and resume it.

प्रमाणीकरण

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

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

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

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

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

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

विवरणहरू

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.

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

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

अनुरोध बडी

नाम	प्रकार	आवश्यक	यो के हो
`name`	`string`	हुन्छ	—
`description`	`string`	हैन	—
`trigger`	`string`	हुन्छ	—
`trigger_config`	`object`	हैन	Per-trigger settings, e.g. `hours_before` for "due date approaching".
`conditions`	`BoardAutomationCondition[]`	हैन	ANDed. An empty list means the rule always matches its trigger.
`actions`	`BoardAutomationAction[]`	हैन	—
`status`	`string<enabled, disabled>`	हैन	—
`position`	`integer`	हैन	—

प्रतिक्रिया

नाम	प्रकार	आवश्यक	यो के हो
`id`	`Uuid`	हुन्छ	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	हुन्छ	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	हुन्छ	—
`description`	`string`	हैन	—
`trigger`	`string`	हुन्छ	—
`trigger_config`	`object`	हैन	—
`conditions`	`BoardAutomationCondition[]`	हैन	—
`actions`	`BoardAutomationAction[]`	हैन	—
`status`	`BoardAutomationStatus`	हुन्छ	`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 collapsing…
`position`	`integer`	हैन	—
`run_count`	`integer`	हैन	—
`fired_count`	`integer`	हैन	—
`consecutive_failures`	`integer`	हैन	—
`suspended_reason`	`string`	हैन	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…
`suspended_at`	`string`	हैन	—
`last_fired_at`	`string`	हैन	—
`last_run_at`	`string`	हैन	—
`next_due_at`	`string`	हैन	Only set for a wall-clock rule. Null for a rule on a live act.
`created_at`	`string`	हैन	—
`updated_at`	`string`	हैन	—

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

401 · 403 · 404 · 422

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