Campaigns

POST /v1/campaigns/{campaignId}/send

Start the durable send.

Gbogbo àwọn Campaigns endpoints

Ìfàṣẹ́pọ̀

Fi bọ́kì kọ́kọ́ (bearer token) ránṣẹ́ gẹ́gẹ́ bí àmì ìdánimọ̀ API. Ibùdó yìí kò sọ àṣẹ pàtó kan nínú àlàyé rẹ̀, nítorí náà fún kọ́kọ́ rẹ̀ ní ohun tó kéré jù lọ tí ó nílò kí o sì ṣàyẹ̀wò ìdáhùn náà dípò kí o kàn rò ó.

Ibùdó àmì ìdánimọ̀ ilé-iṣẹ́ rẹ sí

Ibi-iwọle yii n gba org_id gẹgẹ bi aaye ninu ara JSON naa.

Id àjọ rẹ wa lórí ojú-ìwákòòkò àwọn bọ́tìnnì API nínú daṣibọọdú rẹ, lẹ́gbẹ̀ẹ́ bọ́tìnnì náà gan-an. Ó jẹ́ ìd kan náà nínú gbogbo ìpè tí o bá ṣe.

Gbiyanju rẹ

Rọ́pọ̀ èyíkéyìí nínú àwọn àmì ìtọ́ka < > pẹ̀lú iye tirẹ̀, àti àmì ìdánimọ̀ bọ́tìnnì náà pẹ̀lú bọ́tìnnì kan láti inú dásibọ̀ọ̀dù rẹ.

curl -X POST https://api.zinndigital.com/v1/campaigns/{campaignId}/send \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Ṣé o ti wọlé? Iwọ̀n api ní nú ìgbékalẹ̀ rẹ kún id àjọ gidi rẹ ati bọtini tirẹ, o si nṣiṣẹ ibeere na lòdì si api gidi ki o le rii esi gidi na. Ṣí ojú abáná yìí sílẹ̀ nínú kọnsólù API

Àwọn kúlẹ̀kúlẹ̀

Returns immediately; the send runs as a Temporal workflow that resumes rather than truncating. A send above the confirmation threshold requires `confirm` to equal the campaign's name exactly — enforced here, because a control that lives only in the client is one an API call walks past.

Àwọn ìpìlẹ̀

OrúkọIruTí a nílòKini o jẹ
campaignId (path)stringBẹẹni

Akoonu ibeere naa

OrúkọIruTí a nílòKini o jẹ
confirmstringBẹẹkọ
org_idstringBẹẹkọ

Idahun

OrúkọIruTí a nílòKini o jẹ
idstringBẹẹni
org_idstringBẹẹni
namestringBẹẹni
template_idstringBẹẹni
segment_idstringBẹẹkọ
purposestring<marketing, transactional>Bẹẹni
channelsstring[]Bẹẹni
statusstring<draft, scheduled, sending, paused, sent, cancelled, failed>Bẹẹni
scheduled_forstringBẹẹkọ
include_not_in_good_standingbooleanBẹẹkọ
total_recipientsintegerBẹẹni
skippedCampaignSkipCountsBẹẹni⛔ 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…
deliveryCampaignDeliveryCountsBẹẹkọ⛔ `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_errorstringBẹẹkọ
created_atstringBẹẹni
started_atstringBẹẹkọ
finished_atstringBẹẹkọ

Awọn aṣiṣe ti ibudo ipari yii le da pada

401 · 403 · 404 · 409 · 422