Actualizar un cliente | Documentación API de Recurrente

Actualiza los datos de un cliente. La metadata se fusiona con la existente (deep merge). Para eliminar una key de metadata, envíala con valor null.

Authentication

X-SECRET-KEYstring

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Tu clave secreta de API. Una llave de cuenta (`sk_live_...`, `sk_test_...`) opera sobre su propia cuenta y, con `X-ACCOUNT-ID`, sobre sus cuentas conectadas. Una llave de organización (`sk_org_live_...`, `sk_org_test_...`) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con `X-ACCOUNT-ID`; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde `403` con `code: organization_key_unsupported`.

Path parameters

idstringRequired

ID del cliente

Query parameters

user_idstringOptional

(Alternativa) Buscar por ID de usuario en lugar del ID de cliente

Request

This endpoint expects an object.

namestringOptional

Nuevo nombre del cliente

phonestringOptional

Número de teléfono

addressstringOptional

Dirección

nitstringOptional

Número de identificación tributaria

metadatamap from strings to anyOptional

Metadata a fusionar. Envía una key con valor null para eliminarla.

Response

Cliente actualizado

idstringOptional

ID único del cliente

user_idstringOptional

ID del usuario asociado

emailstringOptionalformat: "email"

Email del cliente

namestringOptional

Nombre del cliente

phonestring or nullOptional

Número de teléfono

addressstring or nullOptional

Dirección

nitstring or nullOptional

Número de identificación tributaria

metadatamap from strings to any or nullOptional

Metadata personalizada

test_clock_idstring or nullOptional

ID del test clock asignado al Customer. Solo puede usarse con una llave de un Sandbox nombrado.

Errors

400

Bad Request Error

$	curl -X PUT https://app.recurrente.com/api/customers/id \
>	-H "X-SECRET-KEY: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"id": "cus_abc123",
3	"user_id": "usr_xyz789",
4	"email": "cliente@ejemplo.com",
5	"name": "Maria Garcia",
6	"phone": "string",
7	"address": "string",
8	"nit": "string",
9	"metadata": {},
10	"test_clock_id": "clock_abc123"
11	}