Campaigns

POST `/v1/campaigns`

Create a campaign from a template and an audience.

ማረጋገጫ

የኤፒአይ ቁልፍ (API key) እንደ ቢረር ቶከን (bearer token) ይላኩ። ይህ የመጨረሻ ነጥብ (endpoint) በመግለጫው ውስጥ የተወሰነ ፈቃድ አልገለጸም፣ ስለዚህ ከማሰብ ይልቅ ለቁልፍዎ የሚያስፈልገውን አነስተኛ ፈቃድ ይስጡት እና ምላሹን ያረጋግጡ።

የድርጅትዎ መታወቂያ የሚገባበት ቦታ

ይህ ማቆሚያ ነጥብ (endpoint) org_idን በJSON አካል ውስጥ እንደ ሜዳ ይወስዳል።

የድርጅትዎ መለያ ቁጥር (ID) በዳሽቦርድዎ ላይ በሚገኙት የኤፒአይ ቁልፎች (API keys) ማያ ገጽ ላይ ከቁልፉ አጠገብ ይገኛል። በሚያደርጉት እያንዳንዱ ጥያቄ ላይ የሚጠቀሙበት መለያ ቁጥር አንድ አይነት ነው።

ሞክሩት

በቅንፍ ውስጥ ያለውን ማንኛውንም ነገር በራስዎ እሴቶች ይተኩ፣ እና ቁልፍ ቦታ ያዢውን ከዳሽቦርድዎ በመጣ ቁልፍ ይተኩ።

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 ኮንሶል ውስጥ ይክፈቱ

ዝርዝሮች

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