Skip to Content
1MSG
ReferenceCampaigns API

Adicionar membros ao segmento

POST
/api/v1/campaigns/segments/{segmentId}/members

members é uma lista não vazia. Cada item precisa de name. phone vai em E.164 ou fica de fora. bsuid é o id no provedor, por exemplo ab.abc123xyz, ou fica de fora. phone ou bsuid é obrigatório. Telefone ou BSUID repetido no segmento é recusado. O segmento pode ter no máximo 500 membros.

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.

Path Parameters

segmentId*string

id do segmento retornado na criação ou na lista.

Request Body

application/json
  1. body
members*array<>

Lista não vazia. Cada item precisa de name e de um telefone ou um BSUID. Telefone ou BSUID repetido no segmento é recusado. O segmento pode ter no máximo 500 membros.

Response Body

application/json
  1. response
items*array<>

Membros gravados por esta requisição.

Example Request
curl -X POST 'https://api.1msg.io/api/v1/campaigns/segments/string/members' \  -H 'Content-Type: application/json' \  -d '{  "members": [    {      "name": "Ana"    }  ]}'
Example Response201
{  "items": [    {      "id": "cm3member01",      "name": "Ana",      "phone": "+15551234567",      "bsuid": "ab.abc123xyz"    }  ]}