Skip to Content
1MSG
ReferenceCampaigns API

Atualizar um segmento

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

Envie só os campos que mudam. name até 200 caracteres. description até 2000 caracteres. segmentId é o id da criação.

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
name?string

Novo nome, até 200 caracteres. Envie só os campos que mudam.

description?string

Nova observação, 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.

memberCount*number

Quantas pessoas há no segmento.

createdAt*string

Quando o segmento foi criado.

Formatdate-time
updatedAt*string

Quando o segmento foi atualizado pela última vez.

Formatdate-time
Example Request
curl -X PATCH 'https://api.1msg.io/api/v1/campaigns/segments/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response200
{  "id": "cm3segment01",  "name": "April buyers",  "description": "string",  "memberCount": 12,  "createdAt": "2026-11-01T09:00:00.000Z",  "updatedAt": "2026-11-01T09:00:00.000Z"}