API reference

Launch a campaign

Move a Draft campaign to Pending and start sending.

POSThttps://nextgenpanelstaging.cloudshope.com/api/v1/email/campaigns/{id}/launch

Runs a preflight check, then builds the send queue for a Draft campaign. Preflight needs at least one valid recipient, one SMTP account, a template_id and a subject_id. Email credit is charged on launch. The call returns as soon as the queue is built — delivery happens asynchronously, paced by batch_size, delay_to and the daily send window.

Poll the analytics endpoint for progress.

Authentication

Send Authorization: Bearer <token>. Any valid API token for the account works.

Path parameters

NameTypeRequiredDescription
idintegerYesCampaign id.

Request

curl -X POST https://nextgenpanelstaging.cloudshope.com/api/v1/email/campaigns/611/launch \
  -H "Authorization: Bearer cs_live_9f2c…"

Response

{ "queued": 2 }
200 — example response

Errors

StatusTypeWhen
400bad-requestThe campaign is not a Draft, preflight failed (no valid recipient, no SMTP account, no template or no subject), or there is not enough Email Service credit.
404not-foundNo campaign with this id on the account.
401unauthorizedThe Authorization header is missing, malformed or the token is invalid or expired.
403forbiddenThe token is valid but the account is not allowed to perform this action.