Leads

Obtener lista paginada de leads

get

Retorna una lista paginada de leads con filtros opcionales. Los leads se ordenan por fecha de creación descendente.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pageinteger · min: 1Optional

Número de página (comienza en 1)

Default: 1
limitinteger · min: 1 · max: 100Optional

Cantidad de leads por página (máximo 100)

Default: 20
connection_typestring · enumOptional

Filtrar por tipo de conexión

Possible values:
tagsstringOptional

Filtrar por IDs de tags (separados por coma)

Example: 507f1f77bcf86cd799439011,507f1f77bcf86cd799439012
searchstringOptional

Búsqueda por nombre, email, teléfono o username de Instagram

start_datestring · date-timeOptional

Filtrar leads creados desde esta fecha (ISO 8601)

end_datestring · date-timeOptional

Filtrar leads creados hasta esta fecha (ISO 8601)

Responses
chevron-right
200

Lista de leads obtenida exitosamente

application/json
get
/leads

Obtener lead por ID

get

Obtiene un lead específico por su ID de MongoDB

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

ID del lead (MongoDB ObjectId)

Example: 507f1f77bcf86cd799439011
Responses
chevron-right
200

Lead obtenido exitosamente

application/json
get
/leads/{id}

Actualizar un lead

patch

Actualiza campos de un lead. Campos permitidos: email, first_name, last_name, comments, variables, phone_number. El campo phone_number solo puede ser actualizado si el tipo de conexión NO es whatsapp-business o whatsapp-lite. Las variables son validadas: deben existir previamente en la organización y el valor debe coincidir con el tipo definido.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

ID del lead

Body

Campos permitidos para actualizar un lead. El campo phone_number solo puede actualizarse si el lead NO es de tipo whatsapp-business o whatsapp-lite. Las variables son validadas: deben existir previamente en la organización y el valor debe coincidir con el tipo definido (text, number, date, link, price, enum). Para enum, el valor debe ser una opción válida.

emailstringOptional

Email del lead

Example: nuevo@email.com
first_namestringOptional

Nombre del lead

Example: Juan
last_namestringOptional

Apellido del lead

Example: Pérez
commentsstringOptional

Comentarios sobre el lead

Example: Cliente VIP
phone_numberstringOptional

Teléfono (solo editable si NO es WhatsApp). Debe contener solo dígitos (6-15 caracteres).

Example: 5491122334455
Responses
chevron-right
200

Lead actualizado exitosamente

application/json
patch
/leads/{id}

Obtener lead por tipo de conexión y contact_id

get

Obtiene un lead específico por su tipo de conexión e identificador de contacto. Útil cuando conoces el teléfono o username pero no el ID interno.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
connection_typestring · enumRequired

Tipo de conexión

Possible values:
contact_idstringRequired

Identificador del contacto (teléfono, username, email, etc)

Example: 5491122334455
Responses
chevron-right
200

Lead obtenido exitosamente

application/json
get
/leads/{connection_type}/{contact_id}

Last updated