v1Ressources/Équipe/postInviter un membre de l'équipe
Inviter un membre de l'équipe
Invite un nouveau membre de l'équipe par e-mail. Le membre invité est toujours créé avec le rôle "member" et, sauf si des permissions sont fournies, le préréglage de permissions par défaut pour member — une clé API ne peut jamais inviter quelqu'un en tant que owner ou admin.
post
team:write/api/v1/team/membersCorps de la requête
firstNamestringobligatoire
Le prénom du nouveau membre de l'équipe.
lastNamestringobligatoire
Le nom de famille du nouveau membre de l'équipe.
emailstringobligatoire
L'adresse e-mail du nouveau membre de l'équipe.
permissionsobjectfacultatif
Indicateurs d'accès par module à accorder. Facultatif ; quand omis (ou vide), le préréglage de permissions par défaut pour member est utilisé.
Réponse
dataobjectfacultatif
userIdstringfacultatif
ID du membre de l'équipe nouvellement invité.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
409La requête entre en conflit avec l'état actuel de la ressource — par exemple, modifier l'e-mail ou le téléphone d'un destinataire à qui un message a déjà été envoyé, ou une invitation d'équipe déjà acceptée (ou pas encore acceptée).
422Il manque un paramètre requis à la requête, ou elle est invalide.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/team/members
Votre clé API
Corps de la requête*
{}