agency-board

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

Change a rule, or pause and resume it.

ప్రమాణీకరణ

ఒక API కీని బేరర్ టోకెన్‌గా పంపండి. ఈ ఎండ్‌పాయింట్ స్పెసిఫికేషన్‌లో నిర్దిష్ట అనుమతిని పేర్కొనలేదు, కాబట్టి ఊహించడం కంటే మీ కీకి అవసరమైన కనిష్ట అనుమతిని ఇవ్వండి మరియు ప్రతిస్పందనను తనిఖీ చేయండి.

ఈ ఎండ్‌పాయింట్ ఎలాంటి సంస్థ ఐడీని తీసుకోదు. మీ కీ ఇప్పటికే అది ఏ సంస్థకు చెందుతుందో గుర్తిస్తుంది మరియు ప్రతిస్పందన దానికే పరిమితం చేయబడుతుంది.

ప్రయత్నించండి

కోణీయ బ్రాకెట్‌లలో ఉన్న దేన్నైనా మీ స్వంత విలువలతో భర్తీ చేయండి, మరియు కీ ప్లేస్‌హోల్డర్‌ను మీ డాష్‌బోర్డ్ నుండి తీసుకున్న కీతో భర్తీ చేయండి.

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 కాన్సోల్ మీ అసలైన సంస్థ ID మరియు మీ స్వంత కీని నింపుతుంది, అలాగే మీరు అసలైన ప్రతిస్పందనను చూడటానికి లైవ్ 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 collapsin…
`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 (`action_re…
`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}