Skip to Content
1MSG
ReferenceCampaigns API

Substituir os membros do segmento

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

Apaga todos os membros atuais e insere esta lista. Valem as mesmas regras de name, phone e bsuid da adição de membros. A nova lista 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<>

Substitui todos os membros atuais. Mesmas regras de name, phone e bsuid da adição de membros. Uma lista vazia limpa o segmento. A nova lista 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 PUT 'https://api.1msg.io/api/v1/campaigns/segments/string/members' \  -H 'Content-Type: application/json' \  -d '{  "members": [    {      "name": "Ana"    }  ]}'
Example Response200
{  "items": [    {      "id": "cm3member01",      "name": "Ana",      "phone": "+15551234567",      "bsuid": "ab.abc123xyz"    }  ]}