agency-board

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

Change a rule, or pause and resume it.

Πισtoποίηση

Στείλτε ένα κλειδί API ως διακριτικό φορέα (bearer token). Αυτό το τελικό σημείο δεν ορίζει μια συγκεκριμένη άδεια στην προδιαγραφή, οπότε δώστε στο κλειδί σας τα ελάχιστα δυνατά δικαιώματα και ελέγξτε την απόκριση αντί να κάνετε υποθέσεις.

Αυτό το τελικό σημείο δεν δέχεται αναγνωριστικό οργανισμού. Το κλειδί σας προσδιορίζει ήδη τον οργανισμό στον οποίο ανήκει, και η απάντηση περιορίζεται σε αυτόν.

Δοκιμάστε το

Ατικatastήstε ό,τι βρίskεtai μέσα σe γώniaδeς μe τis δikές sas timές, kai to placeholder klεidioύ μe éna klεidi apó ton pinaka ελέgchou sas.

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.

Παράμετροι

Όνομα	Τύpος	Υποχρεωτικό	Τι είναι
`boardId (path)`	`Uuid`	Ναι	Project board ID (UUIDv7).
`ruleId (path)`	`Uuid`	Ναι	Automation rule ID (UUIDv7).

Σώμα αίτησης

Όνομα	Τύpος	Υποχρεωτικό	Τι είναι
`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`	Όχι	—

Απάντηση

Όνομα	Τύpος	Υποχρεωτικό	Τι είναι
`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}