Endpoints

Campaigns

Broadcast campaigns created in the app: status, results and sending.

Пути указаны относительно базового URL. В каждой карточке указано, какое разрешение нужно для вызова, и перечислены все параметры с типами и ограничениями.

GET

/campaigns

List campaigns, newest first.

Разрешение: campaigns

Постраничный

Параметры запроса

statusнеобязательноenum
Campaign status.
Допустимые значения:draftscheduledsendingcompletedfailed

GET

/campaigns/:id

Retrieve a campaign with its delivery stats.

Разрешение: campaigns

Параметры пути

idобязательноstring
Campaign ID.

POST

/campaigns/:id/send

Send a draft, scheduled or failed campaign now, or schedule it.

Разрешение: campaigns

Параметры пути

idобязательноstring
Campaign ID.

Тело JSON

send_atнеобязательноstring (ISO 8601 date-time with offset) | null
Schedule for this time. Omit or null to send now.

Sending now answers 202 and runs in the background; campaign.completed fires when it finishes. Scheduling answers 200.
402 insufficient_credits when the workspace cannot pay for the send; 409 for a campaign that is already sending or completed.