POST /v1/contacts/segments
POST
/v1/contacts/segments
const url = 'https://seu-endereco-da-api/v1/contacts/segments';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"name":"example","filter":{},"conditions":{}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://seu-endereco-da-api/v1/contacts/segments \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "example", "filter": {}, "conditions": {} }'Permissão que a Chave de acesso precisa: Gerenciar segmentos (contacts:segments).
Authorizations
Seção intitulada “Authorizations”Request Bodyrequired
Seção intitulada “Request Bodyrequired”Media typeapplication/json
object
name
required
string
filter
required
object
key
additional properties
any
conditions
object
key
additional properties
any
Example generated
{ "name": "example", "filter": {}, "conditions": {}}Responses
Seção intitulada “Responses”Media typeapplication/json
object
id
required
string
name
required
string
filter
required
A arvore de condicoes que o servidor avalia
object
key
additional properties
any
conditions
required
As condicoes como a tela as desenha e reabre; o servidor guarda e devolve sem ler
object
key
additional properties
any
contactCount
required
Quantos contatos alcancaveis a regra pegava na ultima contagem; null quando nunca foi contado
number
countedAt
required
Quando a contagem foi feita
string format: date-time
createdByName
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example generated
{ "id": "example", "name": "example", "filter": {}, "conditions": {}, "contactCount": 1, "countedAt": "2026-04-15T12:00:00Z", "createdByName": "example", "createdAt": "2026-04-15T12:00:00Z", "updatedAt": "2026-04-15T12:00:00Z"}A name already in use by another segment