Skip to Content
1MSG
ReferenceCampaigns API

Atualizar um membro do segmento

PATCH
/api/v1/campaigns/segments/{segmentId}/members/{memberId}

Envie só os campos que mudam. phone precisa continuar em E.164 e bsuid no formato do provedor. Depois da atualização, o membro ainda precisa ter telefone ou BSUID.

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.

memberId*string

id do membro retornado na lista de membros.

Request Body

application/json
  1. body
name?string

Novo nome, até 200 caracteres.

phone?string

Telefone E.164, por exemplo +15551234567. Depois da atualização, o membro ainda precisa ter telefone ou BSUID.

bsuid?string

BSUID do provedor, por exemplo ab.abc123xyz. Um @lid no final é salvo sem ele.

Response Body

application/json
  1. response
id*string

id do membro.

name*string

Nome do membro.

phone*|

Telefone em E.164, ou null quando o membro está salvo pelo BSUID.

bsuid*|

BSUID do provedor sem @lid no final, ou null quando o membro está salvo pelo telefone.

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