agency-board

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

Change a rule, or pause and resume it.

પ્રમાણીકરણ

બિયરર ટૉકન તરીકે API કી મોકલો. આ એન્ડપૉઇન્ટ સ્પેશિફિકેશનમાં કોઈ ચોક્કસ પરવાનગી જણાવતું નથી, તેથી ધારણા બાંધવાને બદલે તમારી કીને તેની જરૂરિયાત મુજબ ન્યૂનતમ પરવાનગી આપો અને રિસ્પોન્સ તપાસો.

આ એન્ડપૉઇન્ટ કોઈ સંસ્થા આઈડી (organisation id) લેતું નથી. તમારી કી (key) પહેલેથી જ તે જે સંસ્થા સાથે સંબંધિત છે તેની ઓળખ કરે છે, અને પ્રતિસાદ (response) તે જ પૂરતો મર્યાદિત છે.

આયમાવો

કોઈપણ કૌંસમાં રહેલી બાબતને તમારા પોતાના મૂલ્યોથી બદલો અને કી પ્લેસહોલ્ડરને તમારા ડેશબોર્ડની કીથી બદલો.

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