Customers
Crear un nuevo cliente en el sistema. Los datos del cliente se envían en formato JSON y deben incluir el idAccount
, publicId
, phone
, y attributes
que describen los datos adicionales del cliente. El cliente se creará en la cuenta asociada
Create
POST https://app.konverting.io/api/customers
Cabeceras de la solicitud
Header | Valor |
---|---|
apikey | {{token}} |
Content-Type | application/json |
Cuerpo RAW de la solicitud
{
"idAccount":"{{idAcoount}}",
"publicId":"{{publicId}}",
"phone":"{{phone}}",
"attributes":[{"key":"pack","value":"prueba"}]
}
Parámetros de la solicitud
-
idAccount
(string): El identificador de la cuenta de usuario. -
Ejemplo:
"DEMO"
-
publicId
(string): Un identificador público para el cliente. -
Ejemplo:
"424"
-
phone
(string): El número de teléfono del cliente. -
Ejemplo:
"53455"
-
attributes
(array de objetos): Un array de atributos personalizados asociados al cliente. -
Cada objeto dentro del array debe contener:
-
key
(string): El nombre del atributo.- Ejemplo:
"pack"
- Ejemplo:
-
value
(string): El valor del atributo.- Ejemplo:
"prueba"
- Ejemplo:
Respuesta de la API
Posibles Respuestas
-
200 OK: La solicitud fue exitosa y el recurso ha sido procesado correctamente.
-
400 Bad Request: La solicitud es malformada o No hay un
token
correcto.
200 Respuesta
{
"id": "{{internalId}}",
"publicId": "{{publicId}}",
"rank": 0,
"name": null,
"phone": "{{phone}}",
"email": null,
"company": null,
"country": null,
"zipcode": null,
"address": null,
"externalCRM": null,
"attributes": "[{\"key\":\"pack\",\"value\":\"prueba\"}]",
"createdAt": "{{dateTime}}",
"updatedAt": "{{dateTime}}",
"idAccount": "{{idAccount}}"
}
Campo | Tipo | Descripción | Ejemplo |
---|---|---|---|
id | String | Identificador único del cliente. | id |
publicId | String | Identificador público del cliente. | publicId |
rank | Integer | Rango del cliente dentro del sistema. | 0 |
name | String | Nombre del cliente (puede ser null). | null |
phone | String | Número de teléfono del cliente. | phone |
String | Correo electrónico del cliente (puede ser null). | null | |
company | String | Nombre de la empresa del cliente (puede ser null). | null |
country | String | País del cliente (puede ser null). | null |
zipcode | String | Código postal del cliente (puede ser null). | null |
address | String | Dirección del cliente (puede ser null). | null |
externalCRM | String | Identificador del CRM externo (puede ser null). | null |
attributes | Array | Atributos personalizados asociados al cliente. | [{"key":"pack","value":"prueba"}] |
createdAt | Date | Fecha de creación del registro. | datetime |
updatedAt | Date | Fecha de la última actualización del registro. | datetime |
idAccount | String | Identificador de la cuenta asociada. | idAccount |
400 Bad Request
{
"error": "No valid apiKey"
}
Nota: Asegúrate de que todos los campos obligatorios se encuentren presentes y correctamente formateados para evitar errores de solicitud malformada.
Read
- Update
- Remove