Passer à la navigation
WorkspaceWorkspaceInvites

Inviter un utilisateur

Envoie une invitation par email à rejoindre votre Workspace à l’adresse fournie. Si l’utilisateur ne possède pas de compte, il est invité à en créer un. S’il accepte cette invitation, il est ajouté comme utilisateur à votre Workspace et à votre abonnement en utilisant l’un de vos sièges. Ce point de terminaison peut uniquement être appelé par des membres du Workspace disposant de l’autorisation WORKSPACE_MEMBERS_INVITE. Si l’utilisateur fait déjà partie du Workspace, une erreur 400 est renvoyée.

En-têtes

xi-api-keystringOptionnel

Requête

This endpoint expects an object.
emailstringRequis

L’email du client

seat_typeenum or nullOptionnel

Le type de siège de l’utilisateur

Valeurs autorisées:
group_idslist of strings or nullOptionnel

Les ID de groupe de l’utilisateur

usage_limitinteger or nullOptionnel>=0
Monthly credit usage limit for the invitee. Omit or set to null for no custom cap.
workspace_permissionstring or nullOptionnelDeprecated

L’autorisation Workspace de l’utilisateur. Ce champ est obsolète, utilisez plutôt seat_type.

Réponse

Réponse réussie

statusstring

L’état de la requête d’invitation au Workspace. Si la requête a réussi, l’état sera « ok ». Sinon, un message d’erreur avec l’état 500 sera renvoyé.

Erreurs

422
Unprocessable Entity Error