Resumen

Esta API te permite crear segmentos de contactos personalizados en Wati. Puedes crear un segmento estático con una lista fija de contactos o un segmento dinámico que se actualiza automáticamente según las condiciones de filtrado. Estos segmentos se pueden utilizar en flujos de trabajo, campañas y procesos de plataforma de datos de clientes (CDP) posteriores.

Instrucciones

Utiliza el endpoint POST /api/v1/createCustomSegment para crear un segmento personalizado.

Puedes crear:

Segmentos estáticos usando IDs de contacto o filtros
Segmentos dinámicos usando condiciones de filtrado que se actualizan automáticamente

Endpoint

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

Autenticación

Este endpoint utiliza autenticación con token Bearer.

Añade la siguiente cabecera a tu solicitud:

Authorization: Bearer YOUR_API_TOKEN

Parámetros requeridos

Parámetro	Tipo	Descripción
`name`	string	Nombre del segmento
`refreshType`	integer	Tipo de segmento. Usa `1` para Estático y `2` para Dinámico

Campos del cuerpo de la solicitud

Campo	Tipo	Requerido	Descripción
`name`	string	Sí	Nombre del segmento
`refreshType`	integer	Sí	Usa `1` para Estático o `2` para Dinámico
`groups`	array of objects	Condicional	Grupos de condiciones de filtrado utilizados para filtrar contactos. Requerido cuando `refreshType = 2`
`contactIds`	array of strings	Condicional	Lista de IDs de contacto utilizados en un segmento estático
`useUploadedContact`	boolean	No	Habilita la lógica de contactos cargados para las APIs de segmentos de CDP posteriores. Por defecto es `false`

Entendiendo los tipos de segmento

Segmento estático

Un segmento estático contiene un conjunto fijo de contactos.

Para segmentos estáticos (refreshType = 1), debes proporcionar uno de los siguientes:

contactIds
groups

Segmento dinámico

Un segmento dinámico se actualiza automáticamente según las condiciones de filtrado.

Para segmentos dinámicos (refreshType = 2), debes proporcionar:

groups

Entendiendo los grupos y las condiciones

El campo groups contiene reglas de filtrado utilizadas para identificar contactos.
Cada grupo contiene una matriz conditions.

Cada condición incluye:

Campo	Descripción
`attribute`	Campo de contacto o atributo personalizado como `name` o `phone`
`operator`	Operador de comparación como `==`
`value`	Valor utilizado para la comparación

Ejemplo de solicitud

Crear un segmento estático usando IDs de contacto

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

Crear un segmento dinámico usando filtros

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

Ejemplo de solicitud 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
}
'

Respuesta exitosa

Una solicitud exitosa devuelve una respuesta 200.

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

Campo	Descripción
`result`	Devuelve `true` cuando el segmento se crea correctamente
`info`	Contiene los detalles del segmento creado

Respuestas de error

400 Solicitud incorrecta

Este error ocurre cuando:

Falta name
refreshType es inválido
Se crea un segmento dinámico sin groups
A un segmento estático le faltan tanto groups como contactIds
La función no está disponible para tu cuenta
Se ha alcanzado el límite de segmentos activos

500 Error interno del servidor

Este error ocurre cuando el servidor no puede crear el segmento debido a un problema interno.

Preguntas frecuentes (FAQ)

Generalidades

1. ¿Qué hace la API de Crear Segmento Personalizado?

La API de Crear Segmento Personalizado te permite crear segmentos de contactos personalizados en Wati. Puedes crear segmentos estáticos con una lista fija de contactos o segmentos dinámicos que se actualizan automáticamente según las condiciones de filtrado. Estos segmentos se pueden utilizar en flujos de trabajo, campañas y procesos de plataforma de datos de clientes (CDP).

2. ¿Qué endpoint se utiliza para crear un segmento personalizado?

Utiliza el siguiente endpoint para crear un segmento personalizado:

POST /api/v1/createCustomSegment

3. ¿Qué método de autenticación utiliza la API de Crear Segmento Personalizado?

La API utiliza autenticación con token Bearer. Añade la siguiente cabecera a tu solicitud:

Authorization: Bearer YOUR_API_TOKEN

Tipos de segmento y campos

4. ¿Qué tipos de segmentos se pueden crear con esta API?

La API admite:

Segmentos estáticos usando IDs de contacto o filtros
Segmentos dinámicos usando condiciones de filtrado que se actualizan automáticamente

5. ¿Cuál es la diferencia entre segmentos estáticos y dinámicos?

Un segmento estático contiene un conjunto fijo de contactos y utiliza refreshType = 1.

Un segmento dinámico se actualiza automáticamente según las condiciones de filtrado y utiliza refreshType = 2.

6. ¿Qué campos se requieren para crear un segmento personalizado?

Los siguientes campos son requeridos:

name — Nombre del segmento
refreshType — Usa 1 para Estático o 2 para Dinámico

Para segmentos dinámicos, el campo groups es requerido.

Para segmentos estáticos, debes proporcionar uno de los siguientes:

contactIds
groups

Grupos y condiciones

7. ¿Qué contiene el campo groups?

El campo groups contiene reglas de filtrado utilizadas para identificar contactos. Cada grupo contiene una matriz conditions.