Campaigns

POST `/v1/campaigns`

Create a campaign from a template and an audience.

அங்கீகாரம்

ஒரு பியரர் டோக்கனாக (bearer token) ஒரு API விசையை அனுப்பவும். இந்த எண்ட்பாயிண்ட் அதன் விவரக்குறிப்பில் குறிப்பிட்ட அனுமதியைக் குறிப்பிடவில்லை, எனவே அனுமானங்களைச் செய்வதற்குப் பதிலாக, உங்கள் விசைக்குத் தேவையான குறைந்தபட்ச அனுமதியை வழங்கவும் மற்றும் பதிலைச் சரிபார்க்கவும்.

உங்கள் அமைப்பு ஐடி எங்கு செல்ல வேண்டும்

இந்த எண்ட்ஸ்பாயிண்ட் JSON பாடியில் உள்ள ஒரு புலமாக org_id-ஐ எடுத்துக்கொள்கிறது.

உங்கள் நிறுவன ஐடி உங்கள் டாஷ்போர்டில் உள்ள API விசைகள் திரையில், விசைக்கு அருகிலேயே உள்ளது. நீங்கள் செய்யும் ஒவ்வொரு அழைப்பிலும் இதுவே ஒரே ஐடி ஆகும்.

முயன்று பார்

கோண அடைப்புக்குறிகளில் உள்ள எதையும் உங்கள் சொந்த மதிப்புகளுடன் மாற்றவும், மேலும் விசை பிளேஸ்ஹோல்டரை உங்கள் டாஷ்போர்டில் உள்ள விசையுடன் மாற்றவும்.

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

உள்நுழைந்துள்ளீர்களா? உங்கள் டேஷ்போர்டில் உள்ள ஏபிஐ கன்சோல் உங்கள் உண்மையான நிறுவன ஐடி மற்றும் உங்கள் சொந்த சாவியை நிரப்புகிறது, மேலும் நேரலை ஏபிஐக்கு எதிராக கோரிக்கையை இயக்குகிறது, இதனால் நீங்கள் உண்மையான பதிலைக் காண முடியும். இந்த எண்ட்மார்க்கை ஏபிஐ கன்சோலில் திறக்கவும்

விவரங்கள்

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