arrobaMail
Testar grátis
Módulo 0513 endpoints

Segmentations /segmentations

Disponível na versão legada e V2 (grupos de condições).

Endpoints

13 no total
GET/segmentations/conditionsUsuário

Condições e operadores disponíveis

Sempre inclui os campos personalizados do usuário em Dados do Assinante; com listIds, filtra esses campos para as listas indicadas.

Query params

NomeTipoObrig.DefaultDescrição
langstringNãoesIdioma: "es" ou "en"
listIdsstringNão-IDs de listas separados por vírgula para limitar os campos personalizados; também aceita all

Exemplo

curl -X GET "https://envios.arrobamail.com/v3/api/segmentations/conditions" \
  -H "Authorization: Bearer $TOKEN"
GET/segmentationsUsuário

Listar segmentações legadas

Exemplo

curl -X GET "https://envios.arrobamail.com/v3/api/segmentations" \
  -H "Authorization: Bearer $TOKEN"
GET/segmentations/:idUsuário

Detalhe de segmentação legada

Parâmetros de rota

NomeDescrição
idID numérico da segmentação (legada)

Exemplo

curl -X GET "https://envios.arrobamail.com/v3/api/segmentations/{ID}" \
  -H "Authorization: Bearer $TOKEN"
GET/segmentations/v2Usuário

Listar segmentações V2

Query params

NomeTipoObrig.DefaultDescrição
typestringNão-Filtro por tipo
isActivebooleanNão-Filtrar por status ativo

Exemplo

curl -X GET "https://envios.arrobamail.com/v3/api/segmentations/v2" \
  -H "Authorization: Bearer $TOKEN"
GET/segmentations/v2/:idUsuário

Detalhe de segmentação V2 com grupos e condições

Parâmetros de rota

NomeDescrição
idID numérico da segmentação V2

Exemplo

curl -X GET "https://envios.arrobamail.com/v3/api/segmentations/v2/{ID}" \
  -H "Authorization: Bearer $TOKEN"
POST/segmentations/v2Usuário

Criar segmentação V2

Nome obrigatório (máx. 200 caracteres). As condições devem ser válidas.

Request body · application/json

NomeTipoObrig.Descrição
namestringSimNome da segmentação (máx. 200 caracteres)
groupsarraySimArray de grupos de condições
listIdsarrayNãoIDs de listas associadas
isActivebooleanNãoDefault: true

Exemplo

curl -X POST "https://envios.arrobamail.com/v3/api/segmentations/v2" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "...",
  "groups": [],
  "listIds": [],
  "isActive": true
}'
PUT/segmentations/v2/:idUsuário

Atualizar segmentação V2

Parâmetros de rota

NomeDescrição
idID da segmentação V2

Request body · application/json

NomeTipoObrig.Descrição
namestringNãoNome
groupsarrayNãoGrupos de condições
isActivebooleanNãoStatus ativo

Exemplo

curl -X PUT "https://envios.arrobamail.com/v3/api/segmentations/v2/{ID}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "...",
  "groups": [],
  "isActive": true
}'

Resposta 200

{ "success": true }
DELETE/segmentations/v2/:idUsuário

Excluir segmentação V2

Parâmetros de rota

NomeDescrição
idID da segmentação V2

Exemplo

curl -X DELETE "https://envios.arrobamail.com/v3/api/segmentations/v2/{ID}" \
  -H "Authorization: Bearer $TOKEN"

Resposta 200

{ "success": true }
POST/segmentations/v2/:id/duplicateUsuário

Duplicar segmentação V2

Parâmetros de rota

NomeDescrição
idID da segmentação V2 a duplicar

Exemplo

curl -X POST "https://envios.arrobamail.com/v3/api/segmentations/v2/{ID}/duplicate" \
  -H "Authorization: Bearer $TOKEN"
POST/segmentations/v2/:id/countUsuário

Contar assinantes que correspondem à segmentação

Parâmetros de rota

NomeDescrição
idID da segmentação V2

Exemplo

curl -X POST "https://envios.arrobamail.com/v3/api/segmentations/v2/{ID}/count" \
  -H "Authorization: Bearer $TOKEN"

Resposta 200

{ "count": 1240 }
POST/segmentations/v2/:id/previewUsuário

Pré-visualização de assinantes correspondentes

Parâmetros de rota

NomeDescrição
idID da segmentação V2

Exemplo

curl -X POST "https://envios.arrobamail.com/v3/api/segmentations/v2/{ID}/preview" \
  -H "Authorization: Bearer $TOKEN"
POST/segmentations/migrate/:idUsuário

Migrar segmentação legada para V2

Parâmetros de rota

NomeDescrição
idID da segmentação legada a migrar

Exemplo

curl -X POST "https://envios.arrobamail.com/v3/api/segmentations/migrate/{ID}" \
  -H "Authorization: Bearer $TOKEN"
POST/segmentations/migrate-allUsuário

Migrar todas as segmentações legadas para V2

Exemplo

curl -X POST "https://envios.arrobamail.com/v3/api/segmentations/migrate-all" \
  -H "Authorization: Bearer $TOKEN"

Comece com o arrobaMail
em menos de 5 minutos.

Plano Gratuito, gerações de IA incluídas, sem cartão de crédito e suporte real em português.

Testar grátis agora
WhatsAppA equipe responde