Passer au contenu principal
POST
cURL

Autorisations

Authorization
string
header
requis

Pour vos propres scripts et vos intégrations de serveur à serveur. Créez une clé dans l'application sous Paramètres > Accès > Clés d'API et copiez-la à ce moment-là, car elle n'est affichée qu'une fois. Envoyez-la sous la forme Authorization: Bearer <key>. La clé agit en tant que le membre qui l'a créée, dans l'organisation où elle a été créée. Un appel exige l'autorisation du membre et l'une des portées de la clé, comme inventory:read ou sales:write. Une clé avec * a toutes les portées.

Paramètres de chemin

customer
string
requis

L'ID du client, un UUID.

Corps

application/json

Une personne chez un client. Le nom et le téléphone sont conservés chiffrés.

name
string
requis

Le nom du contact, jusqu'à 255 caractères.

Maximum string length: 255
role
string | null

Le poste du contact, par exemple Ventes ou Comptabilité, jusqu'à 100 caractères.

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

L'adresse courriel du contact, jusqu'à 255 caractères. Elle est enregistrée en minuscules. Les soumissions et les factures ne sont envoyées par courriel qu'aux contacts qui ont une adresse courriel.

Maximum string length: 255
phone
string | null

Le numéro de téléphone du contact, jusqu'à 50 caractères.

Maximum string length: 50

Réponse

SalesCustomerResource

data
SalesCustomerResource · object
requis

Une entreprise à laquelle l'organisation vend, avec ses contacts lorsqu'elle est affichée seule.