agency-board

POST `/v1/agency/boards/{boardId}/automations`

Create a rule — when this happens, only if that, then do these.

توثيقِ شناخت

ایک API کلید بطور بیر ٹوکن (bearer token) ارسال کریں۔ یہ اینڈ پوائنٹ اسپیسیفیکیشن میں کسی مخصوص اجازت کا ذکر نہیں کرتا، اس لیے فرض کرنے کے بجائے اپنی کلید کو کم از کم درکار اجازت دیں اور رسپانس چیک کریں۔

یہ اینڈ پوائنٹ کوئی آرگنائزیشن آئی ڈی نہیں لیتا۔ آپ کی کلید پہلے ہی اس آرگنائزیشن کی شناخت کرتی ہے جس سے یہ تعلق رکھتی ہے، اور اس کا جواب اسی کے مطابق محدود ہوتا ہے۔

آزمائیں

کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔

curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/automations \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string>, "trigger": <string> }'

لاگ ان ہیں؟ آپ کے ڈیش بورڈ میں موجود API کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو API پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو API کنسول میں کھولیں

تفصیلات

Validated against the catalogue at save time, not at run time. A rule pairing a card action with a trigger that carries no card, naming a context field its trigger does not publish, or using an operator the field's type cannot take is refused here with the offending clause named — because the alternative is a rule that sits in the list looking enabled and does nothing for ever, whose only evidence is an absence.

پیرامیٹرز

نام	قسم	لازمی	یہ کیا ہے
`boardId (path)`	`Uuid`	ہاں	Project board 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

POST /v1/agency/boards/{boardId}/automations