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.

Corps

application/json

L'adresse à inviter et le rôle que la personne obtient.

email
string<email>
requis

L'adresse courriel à laquelle envoyer l'invitation. Inviter de nouveau la même adresse remplace son invitation en attente.

Maximum string length: 255
role_id
integer | null

L'ID du rôle que la personne obtient lorsqu'elle accepte, tiré des rôles qu'un nouveau membre peut recevoir. Omettez-le pour le rôle Membre.

Réponse

InvitationResource

data
InvitationResource · object
requis

Une invitation en attente. Son lien n'est envoyé que dans le courriel et n'est jamais renvoyé par l'API.