Resumo

Esta API permite que você crie segmentos de contato personalizados na Wati. Você pode criar um segmento estático com uma lista fixa de contatos ou um segmento dinâmico que se atualiza automaticamente com base em condições de filtragem. Esses segmentos podem ser usados em fluxos de trabalho subsequentes, campanhas e processos de plataforma de dados do cliente (CDP).

Instruções

Use o endpoint POST /api/v1/createCustomSegment para criar um segmento personalizado.

Você pode criar:

Segmentos estáticos usando IDs de contato ou filtros
Segmentos dinâmicos usando condições de filtragem que atualizam automaticamente

Endpoint

POST https://{WATI_API_ENDPOINT}/api/v1/createCustomSegment

Autenticação

Este endpoint usa autenticação por token Bearer.

Adicione o seguinte cabeçalho à sua solicitação:

Authorization: Bearer YOUR_API_TOKEN

Parâmetros obrigatórios

Parâmetro	Tipo	Descrição
`name`	string	Nome do segmento
`refreshType`	integer	Tipo de segmento. Use `1` para Estático e `2` para Dinâmico

Campos do corpo da requisição

Campo	Tipo	Obrigatório	Descrição
`name`	string	Sim	Nome do segmento
`refreshType`	integer	Sim	Use `1` para Estático ou `2` para Dinâmico
`groups`	array of objects	Condicional	Grupos de condições de filtragem usados para filtrar contatos. Necessário quando `refreshType = 2`
`contactIds`	array of strings	Condicional	Lista de IDs de contato usados em um segmento estático
`useUploadedContact`	boolean	Não	Habilita a lógica de contatos carregados para APIs de segmento de CDP subsequentes. O padrão é `false`

Entendendo os tipos de segmento

Segmento estático

Um segmento estático contém um conjunto fixo de contatos.

Para segmentos estáticos (refreshType = 1), você deve fornecer:

contactIds
groups

Segmento dinâmico

Um segmento dinâmico se atualiza automaticamente com base em condições de filtragem.

Para segmentos dinâmicos (refreshType = 2), você deve fornecer:

groups

Entendendo grupos e condições

O campo groups contém regras de filtragem usadas para identificar contatos.
Cada grupo contém um array conditions.

Cada condição inclui:

Campo	Descrição
`attribute`	Campo de contato ou atributo personalizado, como `name` ou `phone`
`operator`	Operador de comparação, como `==`
`value`	Valor usado para comparação

Exemplo de requisição

Criar um segmento estático usando IDs de contato

{
  "name": "VIP Customers",
  "refreshType": 1,
  "contactIds": [
    "12345",
    "67890"
  ]
}

Criar um segmento dinâmico usando filtros

{
  "name": "Customers from India",
  "refreshType": 2,
  "groups": [
    {
      "conditions": [
        {
          "attribute": "country",
          "operator": "==",
          "value": "India"
        }
      ]
    }
  ]
}

Exemplo de requisição cURL

curl --request POST \
     --url https://wati_api_endpoint/api/v1/createCustomSegment \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "refreshType": 1,
  "useUploadedContact": false
}
'

Resposta de sucesso

Uma requisição bem-sucedida retorna uma resposta 200.

{
  "result": true,
  "info": {
    "id": "segment_id",
    "name": "Customers from India"
  }
}

Campo	Descrição
`result`	Retorna `true` quando o segmento é criado com sucesso
`info`	Contém os detalhes do segmento criado

Respostas de erro

400 Bad Request

Este erro ocorre quando:

name está faltando
refreshType é inválido
Um segmento dinâmico é criado sem groups
Um segmento estático está faltando tanto groups quanto contactIds
O recurso não está disponível para sua conta
O limite de segmentos ativos foi atingido

500 Internal Server Error

Este erro ocorre quando o servidor falha ao criar o segmento devido a um problema interno.

Perguntas Frequentes (FAQs)

Visão Geral

1. O que a API de Criação de Segmento Personalizado faz?

A API de Criação de Segmento Personalizado permite que você crie segmentos de contato personalizados na Wati. Você pode criar segmentos estáticos com uma lista fixa de contatos ou segmentos dinâmicos que se atualizam automaticamente com base em condições de filtragem. Esses segmentos podem ser usados em fluxos de trabalho, campanhas e processos de plataforma de dados do cliente (CDP).

2. Qual endpoint é usado para criar um segmento personalizado?

Use o seguinte endpoint para criar um segmento personalizado:

POST /api/v1/createCustomSegment

3. Qual método de autenticação a API de Criação de Segmento Personalizado usa?

A API usa autenticação por token Bearer. Adicione o seguinte cabeçalho à sua requisição:

Authorization: Bearer YOUR_API_TOKEN

Tipos e campos de segmento

4. Quais tipos de segmentos podem ser criados usando esta API?

A API suporta:

Segmentos estáticos usando IDs de contato ou filtros
Segmentos dinâmicos usando condições de filtragem que atualizam automaticamente

5. Qual é a diferença entre segmentos estáticos e dinâmicos?

Um segmento estático contém um conjunto fixo de contatos e usa refreshType = 1.

Um segmento dinâmico se atualiza automaticamente com base em condições de filtragem e usa refreshType = 2.

6. Quais campos são necessários para criar um segmento personalizado?

Os seguintes campos são obrigatórios:

name — Nome do segmento
refreshType — Use 1 para Estático ou 2 para Dinâmico

Para segmentos dinâmicos, o campo groups é obrigatório.

Para segmentos estáticos, você deve fornecer:

contactIds
groups

Grupos e condições

7. O que o campo groups contém?

O campo groups contém regras de filtragem usadas para identificar contatos. Cada grupo contém um array conditions.