Ce que fait ce point de terminaison d'API

Avec l'API Invitations, vous pouvez créer et supprimer des invitations à Reach 360. Les administrateurs voient cela reflété sous forme d'utilisateurs dans l'onglet En attente. Les utilisateurs reçoivent des e-mails lorsqu'ils sont invités. Si leur invitation en attente est supprimée avant qu'ils n'aient accepté, le lien de l'e-mail ne fonctionnera pas.

Vous pouvez également utiliser cette API pour récupérer la liste de toutes les invitations en attente ou les détails des invitations pour un utilisateur spécifique.

• Points de terminaison
• Objets d'invitation
• Créer une invitation
• Lister les invitations
• Récupérez l'invitation par identifiant
• Supprimer les invitations

Points de terminaison

• POST /invitations—envoyer une invitation à un utilisateur pour qu'il rejoigne votre équipe
• GET /invitations—liste les invitations en attente
• GET /invitations/{invitationId}—obtenir les détails d'une invitation en attente par identifiant d'invitation
• DELETE /invitations/{invitationId}—supprimer une invitation en attente par identifiant d'invitation

Objets d'invitation

• id(chaîne) - l'identifiant unique de l'invitation
• email(string) : adresse e-mail de l'invité
• firstName(string) - le prénom de l'invité
• lastName(string) - le nom de famille de l'invité
• groups(liste de chaînes) - une liste de noms de groupes auxquels l'invité doit être assigné
• url(string) - URL pour récupérer les détails de l'invitation depuis l'API

Créer une invitation

POST /invitations

Paramètres de demande (JSON)

• email(chaîne, obligatoire) - e-mail de l'utilisateur à inviter
• firstName(chaîne, facultatif) - prénom de l'utilisateur à inviter
• lastName(chaîne, facultatif) - nom de famille de l'utilisateur à inviter
• groups(liste de chaînes, facultatif) : liste des noms de groupes auxquels attribuer un utilisateur invité. Les groupes qui n'existent pas sont créés lorsque l'utilisateur accepte l'invitation.

Exemple de réponse

{
« invitation » : {
« id » : « example-invitation-id », 
 « email » : "foo@example.com «, « FirstName » : 
 « Exemple de prénom », « LastName » : 
 « Exemple de nom de famille », « groupes » : ["exemple de groupe a », 
 « exemple de groupe b"]}} 
 

Codes d'erreur spécifiques au point de terminaison

• 'user_exists'- Impossible de créer une invitation car l'adresse e-mail spécifiée possède déjà un compte
• 'invite_pending'- Impossible de créer une invitation car l'adresse e-mail spécifiée a déjà une invitation en attente
• 'max_invites_reached'- Impossible de créer une invitation car vous avez atteint la limite de votre compte d'essai. Passez à un forfait supérieur ou contactez le support technique pour augmenter cette limite.

Lister les invitations

GET /invitations

Paramètres de demande (chaîne de requête)

• limit(entier, facultatif) - le nombre maximum de résultats à renvoyer dans une seule réponse (voir Pagination) ; doit être compris entre 1 et 100 (50 par défaut)
• email(chaîne, facultatif) - si elle est fournie, ne renvoyez les invitations que pour cette adresse e-mail

Exemple de réponse

{
« invitations » : [
{
« id » : « example-invitation-id-1", 
 « email » : "foo@example.com «, « FirstName » : « Exemple de prénom 1 », 
 « LastName » : 
 « Exemple de nom de famille 1 », « groupes » : ["exemple de groupe a », 
 « exemple de groupe b"]},... 
 
], 
 « URL suivante » : "https://url-for-next-page-of-results"} 

Récupérez l'invitation par identifiant

GET /invitations/{invitationId}

Exemple de réponse

{
« id » : « example-invitation-id », 
 « email » : "foo@example.com «, « FirstName » : 
 « Exemple de prénom », « LastName » : 
 « Exemple de nom de famille », « groups » : ["exemple de groupe a », 
 « exemple de groupe b"]} 

Codes d'erreur spécifiques au point de terminaison

• 'invitation_not_found'- Impossible de récupérer l'invitation car elle n'existe pas

Supprimer les invitations

DELETE /invitations/{invitationId}

Réponse réussie

204 « Aucun contenu »

Codes d'erreur spécifiques au point de terminaison

• 'invitation_not_found'- Impossible de récupérer l'invitation car elle n'existe pas