Saltar al contenido principal

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

HeaderValor
apikey{{token}}
Content-Typeapplication/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"
  • value (string): El valor del atributo.

    • Ejemplo: "prueba"

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}}"
}
CampoTipoDescripciónEjemplo
idStringIdentificador único del cliente.id
publicIdStringIdentificador público del cliente.publicId
rankIntegerRango del cliente dentro del sistema.0
nameStringNombre del cliente (puede ser null).null
phoneStringNúmero de teléfono del cliente.phone
emailStringCorreo electrónico del cliente (puede ser null).null
companyStringNombre de la empresa del cliente (puede ser null).null
countryStringPaís del cliente (puede ser null).null
zipcodeStringCódigo postal del cliente (puede ser null).null
addressStringDirección del cliente (puede ser null).null
externalCRMStringIdentificador del CRM externo (puede ser null).null
attributesArrayAtributos personalizados asociados al cliente.[{"key":"pack","value":"prueba"}]
createdAtDateFecha de creación del registro.datetime
updatedAtDateFecha de la última actualización del registro.datetime
idAccountStringIdentificador 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

GET https://app.konverting.io/api/customers

Cabeceras de la solicitud

HeaderValor
apikey{{token}}
Content-Typeapplication/json

Cuerpo RAW de la solicitud

{
"id":"{{customerId}}",
}

Parámetros de la solicitud

  • id? (string): El identificador del cliente .
  • Ejemplo: "DEMO"
  • Update
  • Remove