Skip to navigation
Referencia APICustomers

Crear un cliente

Crea un nuevo cliente. Si ya existe un usuario con el email proporcionado, el cliente se asocia a ese usuario. Si el email es nuevo, se crean tanto el usuario como el cliente.

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.

La llave también fija el ambiente: una sk_test_ solo lista y resuelve objetos de prueba (live_mode: false) y una sk_live_ solo objetos reales. Un ID del otro ambiente responde 404 (401 en /customers).

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.

Request

This endpoint expects an object.
emailstringRequiredformat: "email"

Email del cliente (se usa para buscar o crear el usuario)

full_namestringOptional
Nombre completo
namestringOptional
Nombre para mostrar
phonestringOptional

(Opcional) Número de teléfono

addressstringOptional

(Opcional) Dirección

nitstringOptional

(Opcional) Número de identificación tributaria

metadatamap from strings to stringsOptional

(Opcional) Metadata personalizada

test_clock_idstringOptional

ID de un Test Clock del mismo Sandbox. No está disponible en LIVE.

Response

Cliente creado o encontrado
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