Skip to Content
1MSG
ReferenceCampaigns API

Создать черновик рассылки

POST
/api/v1/campaigns

name — название рассылки. channelId — канал, с которого пойдёт отправка. segmentId — аудитория. content.mode — template или text. Для шаблона задайте content.templateName, content.language и content.params (массив как в sendTemplate). content.messageSendTtlSeconds необязателен, задаётся в секундах и стоит рядом с params. Для текста задайте content.text. Если передаёте status, он должен быть draft.

Authorization

bearer
headerAuthorizationBearer <API key>

Ключ выдаётся в Settings → Developer → API key. Методам Inbox нужен доступ Inbox, методам Campaigns — доступ Campaigns.

Request Body

application/json
  1. body
name*string

Название рассылки в списке.

channelId*string

id канала, с которого идёт отправка. У ключа должен быть доступ к этому каналу.

segmentId*string

id сегмента из POST /campaigns/segments. Участники копируются в момент отправки.

content*

template или text. Для шаблона задайте templateName, language и params.

status?"draft"

Принимается только draft. Если не передать, сохранится draft.

Value in"draft"

Response Body

application/json
  1. response
id*string

id рассылки.

name*string

Название рассылки.

channelId*string

Канал, с которого идёт рассылка.

segmentId*string

Сегмент-аудитория.

status*string

Статус рассылки.

Value in"draft""sending""pause""completed""failed""scheduled"
content*||

Шаблон или текст сессии, сохранённый в рассылке.

sentAt*|

Когда началась отправка, или null, если она ещё не началась.

Formatdate-time
scheduledAt*|

Момент отправки по расписанию в UTC или null.

Formatdate-time
queuedRemaining*number

Получатели, которым ещё не отправили.

sentThisPortion*number

Отправки шаблонов, уже начатые в текущем окне лимита.

dailyLimit*|

Сколько отправок шаблонов этот канал может начать за скользящие 24 часа. Берётся из лимита канала (waba_info.current_limit), а не из настроек рассылки. null, если лимит неизвестен или его нет. Текст сессии не считается.

nextPortionAt*|

Когда может начаться следующая порция шаблонов после того, как окно лимита заполнено. null, если порция не ждёт.

Formatdate-time
createdAt*string

Когда создана рассылка.

Formatdate-time
updatedAt*string

Когда рассылка последний раз менялась.

Formatdate-time
Example Request
curl -X POST 'https://api.1msg.io/api/v1/campaigns' \  -H 'Content-Type: application/json' \  -d '{  "name": "Spring promo",  "channelId": "string",  "segmentId": "string",  "content": {    "mode": "template"  }}'
Example Response201
{  "id": "cm3campaign01",  "name": "April restock",  "channelId": "cm3channel01",  "segmentId": "cm3segment01",  "status": "draft",  "content": {    "mode": "text",    "text": "Hello"  },  "sentAt": "2026-11-01T09:00:00.000Z",  "scheduledAt": "2026-11-01T09:00:00.000Z",  "queuedRemaining": 0,  "sentThisPortion": 0,  "dailyLimit": 1000,  "nextPortionAt": null,  "createdAt": "2026-11-01T09:00:00.000Z",  "updatedAt": "2026-11-01T09:00:00.000Z"}