Crear Cliente

Las consideraciones al momento de registrar un cliente y evitar su duplicidad es validar la existencia del email, de no existir, validar la existencia del documento. De no existir ambos valores, se registrará un nuevo cliente.

Crear Cliente

POST https://api.sperant.com/v3/clients

La creación de cliente implica añadir parámetros obligatorios y opcionales. Los parámetros opcionales se documentarán más adelante.

Consideraciones

La API verifica si ya existe un lead con el mismo DNI, correo electrónico o celular.

Si ya existe un lead con el mismo DNI, correo electrónico o celular, la API no crea un nuevo registro, sino que actualiza únicamente los campos permitidos y que se envían en la solicitud.

Headers

Name	Type	Description
Authorization*	string	Token entregado.

Request Body

Name	Type	Description
fname*	string	Nombres del cliente.
email	string	Email del cliente.
input_channel_id*	integer	Identificador del canal de entrada. Consulta el endpoint Canales de entrada.
source_id*	integer	Identificador del medio de captación. Consulta el endpoint Medios de captación.
interest_type_id*	integer	Identificador del nivel de interés. Consulta el endpoint Niveles de Interés.

200

{
    "data": {
        "type": "clients",
        "id": "80795",
        "links": {
            "referred": "http://api.sperant.com/v3/clients/121"
        },
        "attributes": {
            "id": 80795,
            "uuid": "7d4bf886-b95c9c-0a27",
            "fname": "Almendra Solange",
            "lname": "Oblitas",
            "phone": "[phone]",
            "email": "[e-mail]",
            "created_at": 1574053200,
            "person_type": "natural",
            "gender": "m",
            "document_type_id": 1,
            "document_type": "DNI",
            "document": "987755349",
            "main_telephone": "9898454554",
            "interest_type_id": 4,
            "interest_type": "por contactar",
            "input_channel_id": 2,
            "input_channel": "visita presencial",
            "num_interactions": 69,
            "last_interaction_date": 1615393,
            "email_consent": true,
            "observation": "",
            "extra_fields": {
                "celulares": "9898454554"
            },
            "captation_way_id": 79,
            "captation_way": "digital_ facebook rimac noticias",
            "ubication": {
                "country": "PE",
                "state": "LIM",
                "address": ""
            },
            "couple_id": null,
            "last_agent_assigned": 145,
            "publicity_consent": false,
            "referred_id": 121,
            "lead_priority_id": 1
        }
    }
}

Parámetros opcionales para la creación de cliente

Parámetro	Tipo de Dato	Descripción
lname	string	Apellidos del cliente.
project_id	integer	Identificador del proyecto a relacionar con el cliente. Consulta el endpoint Listar Proyectos.
document_type_id	integer	Identificador del tipo de documento del cliente. Consulta el endpoint Tipos de documento. Si no se envía un valor se basará en configuración de cliente del entorno de consulta (gestión de campos de integraciones) y si no existe un predeterminado se registrará DNI.
document	string	Documento del cliente. Si el campo está en blanco se autogenera un número de documento.
phone	string	Identificador de busqueda o filtro por Telefóno del cliente.
agent_id	integer	Identificador del usuario a asignar al cliente. Consulta el endpoint Usuarios.
utm_source	string	Sirve para identificar un motor de búsqueda, el nombre del boletín u otra fuente. Si no se envía un valor se registrará con el valor sperant.
utm_medium	string	Sirve para identificar un medio como el correo electrónico o el costo por clic. Si no se envía un valor se registrará con el valor api.
utm_campaign	string	Utilizado para el análisis de palabras clave. Sirve para identificar una promoción de producto o campaña estratégica específica.
utm_term	string	Usado para búsquedas pagadas. Sirve para anotar las palabras clave de este anuncio.
utm_content	string	Se usa para pruebas A/B y anuncios orientados por contenido. Sirve para diferenciar anuncios o enlaces que apuntan a la misma URL.
publicity_consent	boolean	Se usa para conocer si el cliente autoriza el envío de publicidad.
email_consent	boolean	Se usa para conocer si el cliente autoriza el uso de datos.
country	string	País del cliente en formato ISO_CODE. Si no se envía un valor se basará en configuración de cliente del entorno de consulta (gestión de campos de integraciones) y si no existe un predeterminado se registrará nulo.
department	string	Departamento del cliente en formato ISO_CODE. Si no se envía un valor se basará en configuración de cliente del entorno de consulta (gestión de campos de integraciones) y si no existe un predeterminado se registrará nulo.
person_type_id	integer	Identificador del tipo de persona del cliente. Los valores a enviar son: 1 -> natural 2 -> legal Si no se envía un valor se basará en configuración de cliente del entorno de consulta (gestión de campos de integraciones) y si no existe un predeterminado se registrará natural.
referred_id	integer	ID Referido
gender	string	Nombre del género del cliente. Los valores a enviar son: f -> femenino m -> masculino Si no se envía un valor se basará en configuración de cliente del entorno de consulta (gestión de campos de integraciones) y si no existe un predeterminado se registrará nulo.
date_of_birth	timestamp	Fecha de cumpleaños del cliente.
is_fit	boolean	Se usa para conocer si el cliente es apto. Si no se envía un valor se registrará true (apto).
address	string	Dirección del cliente.
occupation	string	Ocupación del cliente.
potential_buyer	boolean	Se usa para definir si el cliente es comprador potencial. Si no se envía un valor se registrará true (potencial).
observation	string	Son las observaciones que desea enviar en el registro del cliente. SI necesita enviar datos que no encuentra en la API puede enviar a través de esta opción.
geoAddress	string	Ubicación de la geolocalización
geoLatitud	float	Latitud
geoLongitud	float	Longitud
lead_priority_id	integer	Identificador de Prioridad del Lead
created_at	string	Esta es la fecha de creación para ver. Para ver fechas de interacción usar el endpoint listar proyecto del cliente

• Extra_fields (Datos Extras)

Los datos extras se mostrarán tal cual se registran en el CRM y el tipo de dato será el mismo que coloquen allí.

El envío de atributos para crear un cliente debe ser en el siguiente formato:

{
    "data": {
        "type": "clients",
        "id": "80795",
        "links": {
            "referred": "http://api.sperant.com/v3/clients/121"
        },
{
    "fname": "Almendra",
    "email": "[e-mail]",
    "input_channel_id": 8,
    "source_id": 2,
    "interest_type_id": 4,
    "phone": "[phone]",
    "project_id": 19,
    "extra_fields":{
        "actividad_economica_de_la_empresa": "comercio"
    }
}

Datos que se registran en Sperant

• Se asignará vendedor de acuerdo a la lógica de asignación. Para ver la asignación de vendedores, visitar: Asignación de Vendedores​

• Se creará la interacción de Creación de cliente (solo si es nuevo cliente).

• Se enviará un correo de Bienvenida al correo del cliente.

• Se enviará un correo de Asignación de cliente al vendedor asignado

• En la interacción se guardará los campos UTM (si no envian valores en estos utms):

  • utm_source: sperant

  • utm_medium: api