Actualizar un objeto Client

Permite actualizar los datos de un cliente existente. Solo se actualizan los campos enviados en el body; los demás se mantienen.

PUT /v3/client/{uuid}

Ambiente	URL base API	Portal de comercio
Sandbox	https://api.virtualpos-sandbox.com	comercios.virtualpos-sandbox.com
Producción	https://api.virtualpos.cl	comercios.virtualpos.cl

Headers

Nombre	Tipo	Requerido	Descripción
Content-Type	string	No
Authorization	string	Sí	API KEY del comercio
Signature	string	Sí	Firma del mensaje

Parámetros de consulta

Nombre	Tipo	Requerido	Descripción
uuid	string	Sí	Identificador único del cliente a actualizar.

Body

Campo	Tipo	Requerido	Descripción
type	string	Sí	PERSONA o EMPRESA Valores: 'PERSONA', 'EMPRESA'.
first_name	string	Sí	Nombre del cliente (o razón social si es type = EMPRESA) Por defecto: John.
last_name	string	Sí	Obligatorio cuando es type = PERSONA. Opcional para EMPRESA Por defecto: Doe.
social_id_type	string	Sí	1 si es RUT o 2 si es DNI. Si es RUT se valida el formato. Por defecto: 1.
social_id	string	Sí	Número de documento asociado a social_id_type. Debe ser único. Por defecto: 15111111-2.
email	string	Sí	Email del cliente. Debe ser único y con formato válido Por defecto: john@virtualpos.cl.
phone	string	No	Teléfono del cliente.
private_note	string	No	Nota interna del comercio. Por defecto: Creado desde CRM.
status	string	No	Estatus del cliente Por defecto: ACTIVO.
gender_id	string	No	1 para Masculino, 2 Femenino o 4 para Otro Valores: 1, 2. Por defecto: 1.
birth_date	string	No	Fecha de nacimiento del cliente Por defecto: 1990-10-10.

Ejemplo de request

curl -X PUT 'https://api.virtualpos-sandbox.com/v3/client/{uuid}?uuid=...' \
  -H 'Content-Type: application/json' \
  -H "Authorization: $API_KEY" \
  -H "Signature: $SIGNATURE" \
  -d '{
  "type": "'\''PERSONA'\''",
  "first_name": "John",
  "last_name": "Doe",
  "social_id_type": "1",
  "social_id": "15111111-2",
  "email": "john@virtualpos.cl",
  "phone": "<phone>",
  "private_note": "Creado desde CRM",
  "status": "ACTIVO",
  "gender_id": "1",
  "birth_date": "1990-10-10"
}'

Respuestas

200 OK

{
  "client": {
    "uuid": "cli_00183af742e91dc3",
    "status": "BLOQUEADO",
    "type": "PERSONA",
    "first_name": "John",
    "last_name": "Doe",
    "email": "user@example.com",
    "phone_number": "56977777777",
    "social_id_type": "RUT",
    "social_id": "12345678-9",
    "birth_date": "1990-01-01",
    "gender_id": "Masculino",
    "private_note": "Cliente bloqueado por mora.",
    "created": "2025-01-08 11:20:31",
    "updated": "2025-01-15 10:30:00"
  }
}

400 Bad Request

{
  "status": "NOK",
  "code": 400,
  "error": {
    "error_code": "E-###",
    "message": "detalle del error",
    "doc_url": "https://virtualpos.readme.io/reference/objeto-error"
  }
}