Saltar al contenido principal
PUT
cURL

Autorizaciones

Authorization
string
header
requerido

Para tus propios scripts e integraciones de servidor a servidor. Crea una clave en la app en Configuración > Acceso > Claves de API y cópiala entonces, porque se muestra una sola vez. Envíala como Authorization: Bearer <key>. La clave actúa como el miembro que la creó, en la organización en la que se creó. Una llamada necesita el permiso del miembro y uno de los alcances de la clave, como inventory:read o sales:write. Una clave con * tiene todos los alcances.

Parámetros de ruta

customer
string
requerido

El ID del cliente, un UUID.

contact
string
requerido

El ID del contacto del cliente, un UUID.

Cuerpo

application/json

Una persona en un cliente. El nombre y el teléfono se guardan cifrados.

name
string
requerido

El nombre del contacto, de hasta 255 caracteres.

Maximum string length: 255
role
string | null

El puesto del contacto, como Ventas o Cuentas, de hasta 100 caracteres.

Maximum string length: 100
email
string<email> | null

La dirección de correo electrónico del contacto, de hasta 255 caracteres. Se guarda en minúsculas. Las cotizaciones y facturas se envían por correo electrónico solo a los contactos con una dirección de correo electrónico.

Maximum string length: 255
phone
string | null

El número de teléfono del contacto, de hasta 50 caracteres.

Maximum string length: 50

Respuesta

SalesCustomerResource

data
SalesCustomerResource · object
requerido

Una empresa a la que vende la organización, con sus contactos cuando se muestra por separado.