Actualiza datos del perfil (parcial)

patch

https://api3.clau.io/ext/v3/clientes/{uid}

Solo cambia los campos enviados; el resto se conserva. Para cambiar el email use POST /clientes/{uid}/email.

Scope requerido: clientes:write

Escritura: header Idempotency-Key obligatorio.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Solo cambia los campos enviados; el resto se conserva. Para cambiar el email use POST /clientes/{uid}/email.


Scope requerido	`clientes:write`
Método	`PATCH /ext/v3/clientes/{uid}`
Idempotencia	header `Idempotency-Key` obligatorio

Path

Parámetro	Tipo	Requerido	Descripción
`uid`	string	sí	UID del cliente (user_fireb_uid)

Body

Parámetro	Tipo	Requerido	Descripción
`nombre`	string	no
`apellido`	string	no
`telefono`	string	no
`tipoId`	string	no	Tipo de identificacion (ej. Cedula, Pasaporte)
`numId`	string	no
`extId`	string	no	Id externo del cliente (ERP/POS)
`genero`	string	no
`ciudad`	string	no
`birthday`	date	no	YYYY-MM-DD
`tipoContribuyente`	integer	no	Tipo fiscal 1..6 (ver contrato CustomerTypeId)
`digitoVerificador`	string	no
`genericString1`	string	no
`genericInt1`	integer	no
`genericString2`	string	no
`genericInt2`	integer	no
`genericString3`	string	no
`genericInt3`	integer	no
`genericString4`	string	no
`genericInt4`	integer	no
`genericString5`	string	no
`genericInt5`	integer	no
`genericDate1`	date	no
`genericDate2`	date	no

Ejemplo

curl -X PATCH 'https://api3.clau.io/ext/v3/clientes/uid-7' \
  -H 'apikey: ck_1_...' \
  -H 'Idempotency-Key: 6f1e2d3c-0001' \
  -H 'Content-Type: application/json' \
  -d '{"nombre":"Ana","telefono":"60000000","genericString1":"Canal POS"}'

Respuesta 200

{
  "codigoRespuesta": 0,
  "msj": "Exito",
  "data": "…",
  "meta": {
    "requestId": "5f1c…",
    "appId": 1,
    "scope": "clientes:write"
  }
}

Errores: 401 key inválida (9501), 403 sin scope (9503, meta.requiredScope), 400 parámetros (details), 409 idempotencia, 422 regla de negocio (meta.legacy), 429 límite de tasa. Agregue ?help=true para la ayuda en texto plano.

Path Params

uid

string

required

length ≤ 128

UID del cliente (user_fireb_uid)

Query Params

help

boolean

Con true devuelve la ayuda del endpoint en texto plano.

Body Params

nombre

string

length ≤ 120

apellido

string

length ≤ 120

telefono

string

length ≤ 40

tipoId

string

length ≤ 40

Tipo de identificacion (ej. Cedula, Pasaporte)

numId

string

length ≤ 60

extId

string

length ≤ 120

Id externo del cliente (ERP/POS)

genero

string

length ≤ 30

ciudad

string

length ≤ 120

birthday

date

YYYY-MM-DD

tipoContribuyente

integer

1 to 6

Tipo fiscal 1..6 (ver contrato CustomerTypeId)

digitoVerificador

string

length ≤ 5

genericString1

string

length ≤ 255

genericInt1

integer

genericString2

string

length ≤ 255

genericInt2

integer

genericString3

string

length ≤ 255

genericInt3

integer

genericString4

string

length ≤ 255

genericInt4

integer

genericString5

string

length ≤ 255

genericInt5

integer

genericDate1

date

genericDate2

date

Headers

Idempotency-Key

string

required

length between 8 and 128

Identificador unico de la operacion (8 a 128 caracteres, p. ej. un UUID). Repetir con el mismo cuerpo devuelve la respuesta original; con otro cuerpo responde 409.

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Exito

400Parametros invalidos (details) o Idempotency-Key ausente

401API key ausente, invalida, revocada o vencida (codigoRespuesta 9501)

403La key no tiene el scope clientes:write (codigoRespuesta 9503, meta.requiredScope)

404Recurso no encontrado

409Idempotency-Key repetida con un cuerpo distinto o request en proceso

422Regla de negocio: codigoRespuesta y msj del dashboard, meta.legacy = true

429Limite de tasa; ver Retry-After y X-RateLimit-*

500Error interno