Skip to Content
1MSG
ReferenceCampaigns API

Criar um rascunho de campanha

POST
/api/v1/campaigns

name é o título da campanha. channelId é o canal que vai enviar. segmentId é o público. content.mode é template ou text. Para template, defina content.templateName, content.language e content.params (o array do sendTemplate). content.messageSendTtlSeconds é opcional, em segundos, e fica ao lado de params. Para texto, defina content.text. Se status for enviado, precisa ser draft.

Authorization

bearer
headerAuthorizationBearer <API key>

Chave gerada em Settings → Developer → API key. Os métodos do Inbox precisam do escopo Inbox. Os métodos de Campaigns precisam do escopo Campaigns.

Request Body

application/json
  1. body
name*string

Título da campanha mostrado na lista.

channelId*string

id do canal que envia. A chave precisa ter permissão para usar esse canal.

segmentId*string

id do segmento de POST /campaigns/segments. Os membros são copiados no envio.

content*

template ou text. Para template, defina templateName, language e params.

status?"draft"

Só draft é aceito. Sem o campo, fica salvo como draft.

Value in"draft"

Response Body

application/json
  1. response
id*string

id da campanha.

name*string

Título da campanha.

channelId*string

Canal que envia a campanha.

segmentId*string

Segmento usado como público.

status*string

Status da campanha.

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

Template ou texto da sessão salvo na campanha.

sentAt*|

Quando o envio começou, ou null se ainda não começou.

Formatdate-time
scheduledAt*|

Instante UTC de um envio agendado, ou null.

Formatdate-time
queuedRemaining*number

Destinatários que ainda aguardam o envio.

sentThisPortion*number

Envios de template já iniciados na janela atual do limite.

dailyLimit*|

Quantos envios de template este canal pode iniciar em 24 horas corridas. Vem do limite do canal (waba_info.current_limit), não de uma configuração da campanha. null quando o limite é desconhecido ou ilimitado. Texto da sessão não conta.

nextPortionAt*|

Quando a próxima leva de templates pode começar depois que a janela do limite encheu. null quando nenhuma leva está esperando.

Formatdate-time
createdAt*string

Quando a campanha foi criada.

Formatdate-time
updatedAt*string

Quando a campanha foi atualizada pela última vez.

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