agency-board

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

Change a rule, or pause and resume it.

ავტორიზაცია

API გასაღები გაგზავნეთ როგორც bearer token. ეს ენდპოინტი სპეციფიკაციაში არ მიუთითებს კონკრეტულ ნებართვას, ამიტომ მიანიჭეთ თქვენს გასაღებს მინიმალური საჭირო უფლებები და ვარაუდის ნაცვლად შეამოწმეთ პასუხი.

ეს ბოლო წერტილი არ იღებს ორგანიზაციის იდენტიფიკატორს. თქვენი გასაღები უკვე აიდენტიფიცირებს იმ ორგანიზაციას, რომელსაც ის ეკუთვნის, და პასუხი შემოფარგლულია მისით.

სცადეთ

შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.

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-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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}