ZaplinDocs
GuiasReferência da APIMCPChangelogAbrir o app

Criar campanha

POST
/v1/campaigns

Cria um rascunho de campanha; nunca envia. pace é a velocidade de envio.

Escopo: campaigns:write

Autorização

bearer campaigns:write
headerAutorizaçãoBearer <token>

A chave de API de uma conta de serviço (sk_live_…, 600 requisições por minuto cada) ou um access token OAuth para o recurso /api/v1 (600 requisições por minuto por conexão).

Escopo: campaigns:write

Cabeçalhos

Idempotency-Key?string

Até 200 letras, dígitos, - ou _. A primeira resposta a uma chave é repetida por 24 horas.

Tamanholength <= 200

Corpo da requisição

application/json
  1. body
name*string
Tamanho1 <= length <= 80
number_id*string
Tamanho1 <= length <= 100
target*string
Valor em"segment""contacts""groups"
segment_id?|
Padrãonull
contact_ids?array<>
Itensitems <= 1000
Padrão[]
group_ids?array<>
Itensitems <= 100
Padrão[]
text*string
Tamanho1 <= length <= 4096
when?|
Padrãonull
pace*number|number|number|number

Corpo da resposta

Feito.

application/json
  1. response
id*string
name*string
status*string
Valor em"draft""scheduled""sending""paused""done""cancelled"
number_id*string|null
target*string
Valor em"segment""contacts""groups""pipeline"
segment_id*string|null
contact_ids*array<string>
group_ids*array<string>
text*string
send_at*|null
pace*integer
Intervalo-9007199254740991 <= value <= 9007199254740991
started_at*|null
finished_at*|null
created_at*string
Formatodate-time
Exemplo de requisição
curl -X POST 'https://app.zaplin.com.br/api/v1/campaigns' \  -H 'Authorization: Bearer sk_live_...' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "number_id": "string",  "target": "segment",  "text": "string",  "pace": 5}'
Exemplo de resposta
{  "id": "string",  "name": "string",  "status": "draft",  "number_id": "string",  "target": "segment",  "segment_id": "string",  "contact_ids": [    "string"  ],  "group_ids": [    "string"  ],  "text": "string",  "send_at": "2026-10-17T12:00:00.000Z",  "pace": 0,  "started_at": "2026-10-17T12:00:00.000Z",  "finished_at": "2026-10-17T12:00:00.000Z",  "created_at": "2026-10-17T12:00:00.000Z"}