Was dieser API-Endpunkt macht

Mit der Einladungs-API können Sie Einladungen zu Reach 360 erstellen und löschen. Für Administratoren wird dies als Benutzer auf der Registerkarte Ausstehend angezeigt. Benutzer erhalten E-Mails, wenn sie eingeladen werden. Wenn ihre ausstehende Einladung gelöscht wird, bevor sie sie annehmen, funktioniert der E-Mail-Link nicht.

Sie können diese API auch verwenden, um eine Liste aller ausstehenden Einladungen oder Einladungsdetails für einen bestimmten Benutzer abzurufen.

• Endpunkte
• Einladungsobjekte
• Einladung erstellen
• Einladungen auflisten
• Einladung anhand der ID abrufen
• Einladungen löschen

Endpunkte

• POST /invitations—Senden Sie eine Einladung an einen Benutzer, Ihrem Team beizutreten
• GET /invitations— listet ausstehende Einladungen auf
• GET /invitations/{invitationId}— Informationen zu ausstehenden Einladungen anhand der Einladungs-ID abrufen
• DELETE /invitations/{invitationId}— löscht eine ausstehende Einladung anhand der Einladungs-ID

Objekte der Einladung

• id(string) — die eindeutige Kennung der Einladung
• email(string) — die E-Mail-Adresse des Eingeladenen
• firstName(string) — der Vorname des Eingeladenen
• lastName(string) — der Nachname des Eingeladenen
• groups(Liste von Zeichenketten) — eine Liste von Gruppennamen, denen der Eingeladene zugewiesen werden soll
• url(string) — URL zum Abrufen der Einladungsdetails von der API

Einladung erstellen

POST /invitations

Anforderungsparameter (JSON)

• email(Zeichenfolge, erforderlich) — E-Mail-Adresse des Benutzers, der eingeladen werden soll
• firstName(string, optional) — Vorname des Benutzers, der eingeladen werden soll
• lastName(string, optional) — Nachname des Benutzers, der eingeladen werden soll
• groups(Liste mit Zeichenketten, optional) — Liste von Gruppennamen, denen der eingeladene Benutzer zugewiesen werden soll. Alle Gruppen, die nicht existieren, werden erstellt, wenn der Benutzer die Einladung annimmt.

Beispiel für eine Antwort

{
„Einladung“: {
„id“: „example-invitation-id“, 
 „email“: "foo@example.com“, „firstName“: 
 „Beispiel Vorname“, „lastName“: 
 „Beispiel Nachname“, „Beispiel Nachname“, 
 „groups“: ["Beispiel Gruppe a“, „Beispiel Gruppe b"]}} 
 

Endpunktspezifische Fehlercodes

• 'user_exists'- kann keine Einladung erstellen, da die angegebene E-Mail-Adresse bereits über ein Konto verfügt
• 'invite_pending'- kann keine Einladung erstellen, da für die angegebene E-Mail-Adresse bereits eine Einladung aussteht
• 'max_invites_reached'- kann keine Einladung erstellen, da Sie Ihr Limit für Ihr Testkonto erreicht haben. Bitte aktualisieren Sie Ihren Tarif oder wenden Sie sich an den Support, um dieses Limit erhöhen zu lassen.

Einladungen auflisten

GET /invitations

Anforderungsparameter (Abfragezeichenfolge)

• limit(Ganzzahl, optional) — die maximale Anzahl von Ergebnissen, die in einer einzigen Antwort zurückgegeben werden können (siehe Paginierung); muss zwischen 1 und 100 liegen (standardmäßig 50)
• email(string, optional) — falls angegeben, senden Sie nur Einladungen für diese E-Mail-Adresse

Beispiel für eine Antwort

{
„Einladungen“: [
{
„id“: „example-invitation-id-1", 
 „email“: "foo@example.com „, 
 „firstName“: „Beispiel Vorname 1", „lastName“: 
 „Beispiel Nachname 1", „groups“: ["Beispiel Gruppe a“, 
 „Beispiel Gruppe b"]},... 
 
], „nextUrl“: "https://url-for-next-page-of-results"} 
 

Einladung anhand der ID abrufen

GET /invitations/{invitationId}

Beispiel für eine Antwort

{
„id“: „example-invitation-id“, 
 „email“: "foo@example.com „, 
 „firstName“: „Beispiel Vorname“, „lastName“: 
 „Beispiel Nachname“, „groups“: ["example group a“, 
 „example group b"]} 

Endpunktspezifische Fehlercodes

• 'invitation_not_found'- Die Einladung kann nicht abgerufen werden, da die Einladung nicht existiert

Einladungen löschen

DELETE /invitations/{invitationId}

Erfolgreiche Antwort

204 „Kein Inhalt“

Endpunktspezifische Fehlercodes

• 'invitation_not_found'- Die Einladung kann nicht abgerufen werden, da die Einladung nicht existiert