Skip to Content
1MSG
ReferenceCampaigns API

Criar um segmento

POST
/api/v1/campaigns/segments

name é obrigatório, até 200 caracteres. description é opcional, até 2000 caracteres. Retorna o id do segmento, usado ao criar uma campanha.

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

Nome do segmento, até 200 caracteres.

description?string

Observação opcional, até 2000 caracteres.

Response Body

application/json
  1. response
id*string

id do segmento.

name*string

Nome do segmento, até 200 caracteres.

description*|

Observação opcional, até 2000 caracteres, ou null quando não há nenhuma.

createdAt*string

Quando o segmento foi criado.

Formatdate-time
Example Request
curl -X POST 'https://api.1msg.io/api/v1/campaigns/segments' \  -H 'Content-Type: application/json' \  -d '{  "name": "April buyers"}'
Example Response201
{  "id": "cm3segment01",  "name": "April buyers",  "description": "People who bought in April",  "createdAt": "2026-11-01T09:00:00.000Z"}