Skip to content

Customer/:id

Request

Obtén los datos de un cliente en especifico buscado por ID

Security
api-key
curl -i -X GET \
  https://app.mercately.com/retailers/api/v1/customers/:id \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
idstring

ID único del cliente (web_id)

first_namestring
last_namestring
emailstring
phonestring
id_typestring
Enum:"cedula""pasaporte""ruc""rut""otro"
id_numberstring
addressstring

Dirección individual del cliente

citystring

Ciudad individual del cliente

statestring

Estado/Provincia individual del cliente

zip_codestring

Código postal individual del cliente

country_idstring

ID del país del cliente

notesstring
whatsapp_opt_inboolean

Si el cliente ha optado por recibir mensajes de WhatsApp

whatsapp_namestring

Nombre del cliente en WhatsApp

customer_addressesArray of objects

Array de direcciones adicionales del cliente

tagsArray of objects

Array de etiquetas del cliente

custom_fieldsArray of objects

Array de campos personalizados del cliente

agentobject

Agente asignado al cliente

outbound_statusstring

Estado del último mensaje outbound enviado al cliente

Enum:"error""submitted""enqueued""sent""delivered""read"
campaign_idinteger

ID de la campaña asociada al cliente

error_messagestring

Mensaje de error si hubo un problema con el último mensaje enviado

campaign_urlstring

URL de la campaña asociada (vacío si no hay campaña)

creation_datestring, (date-time)

Fecha de creación del cliente

sent_atstring, (date-time)

Fecha en que se envió el último mensaje outbound

delivered_atstring, (date-time)

Fecha en que se entregó el último mensaje outbound

read_atstring, (date-time)

Fecha en que se leyó el último mensaje outbound

last_chat_interactionstring, (date-time)

Fecha de la última interacción en el chat

Response
{
  "id": "string",
  "first_name": "string",
  "last_name": "string",
  "email": "string",
  "phone": "string",
  "id_type": "cedula",
  "id_number": "string",
  "address": "string",
  "city": "string",
  "state": "string",
  "zip_code": "string",
  "country_id": "string",
  "notes": "string",
  "whatsapp_opt_in": true,
  "whatsapp_name": "string",
  "customer_addresses": [
    { … }
  ],
  "tags": [
    { … }
  ],
  "custom_fields": [
    { … }
  ],
  "agent": {
    "id": 0,
    "email": "string"
  },
  "outbound_status": "error",
  "campaign_id": 0,
  "error_message": "string",
  "campaign_url": "string",
  "creation_date": "2019-08-24T14:15:22Z",
  "sent_at": "2019-08-24T14:15:22Z",
  "delivered_at": "2019-08-24T14:15:22Z",
  "read_at": "2019-08-24T14:15:22Z",
  "last_chat_interaction": "2019-08-24T14:15:22Z"
}
Copyleft © Mercately Inc.