Campaigns

POST `/v1/campaigns`

Create a campaign from a template and an audience.

ავტორიზაცია

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

სwhere your organisation id goes-ის ადგილი

ესენდპოინტი იღებს org_id-ს JSON ტანის ველად.

თქვენი ორგანიზაციის ID მითითებულია თქვენი სამართავი პანელის API გასაღებების ეკრანზე, თავად გასაღებთან ახლოს. ის ერთნაირია თქვენ მიერ განხორციელებულ ყველა გამოძახებაში.

სცადეთ

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

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

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

დეტალები

Create a campaign from a template and an audience segment. It is created as a draft and sends nothing until the send endpoint is called.

მოთხოვნის სხეული

სახელი	ტიპი	სავალდებულო	რა არის ეს
`name`	`string`	დიახ	—
`template_id`	`string`	დიახ	—
`segment_id`	`string`	არა	—
`channels`	`string<email, in_app, slack, telegram>[]`	არა	—
`scheduled_for`	`string`	არა	—
`include_not_in_good_standing`	`boolean`	არა	⚖️ Suspended and unpaid organisations are excluded by default (CLAUDE.md §2.46); this is the explicit per-campaign override that makes a win-back campaign possible. The skip is…
`org_id`	`string`	არა	—

პასუხი

სახელი	ტიპი	სავალდებულო	რა არის ეს
`id`	`string`	დიახ	—
`org_id`	`string`	დიახ	—
`name`	`string`	დიახ	—
`template_id`	`string`	დიახ	—
`segment_id`	`string`	არა	—
`purpose`	`string<marketing, transactional>`	დიახ	—
`channels`	`string[]`	დიახ	—
`status`	`string<draft, scheduled, sending, paused, sent, cancelled, failed>`	დიახ	—
`scheduled_for`	`string`	არა	—
`include_not_in_good_standing`	`boolean`	არა	—
`total_recipients`	`integer`	დიახ	—
`skipped`	`CampaignSkipCounts`	დიახ	⛔ Every skip counted separately and never silent, and every one is present even when it is zero. "4,127 recipients, 312 skipped — not in good standing" is rendered from thes…
`delivery`	`CampaignDeliveryCounts`	არა	⛔ `sent` is NOT `delivered`. `sent` means a provider accepted the hand-off; `delivered` means the receiving server accepted it, which arrives later by webhook. A screen showing…
`last_error`	`string`	არა	—
`created_at`	`string`	დიახ	—
`started_at`	`string`	არა	—
`finished_at`	`string`	არა	—

შეცდომები, რომლებიც ამ ენდპოინტს შეუძლია დააბრუნოს

401 · 403 · 422

POST /v1/campaigns