Browse Articles

Browse Articles

Reach 360: Einladungs-API

Letzte Aktualisierung des Artikels:

Dieser Artikel gilt für:

Reach 360

Was dieser API-Endpunkt macht

Mit der Einladungs-API erstellen und löschen Sie Einladungen zu Reach 360. Admins sehen, dass dies als Benutzer auf der Registerkarte „Ausstehend“ angezeigt wird. 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

  • POST /invitations—sende eine Einladung an einen Benutzer, deinem Team beizutreten
  • GET /invitations— ausstehende Einladungen auflisten
  • GET /invitations/{invitationId}—Informationen zu einer ausstehenden Einladung 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 der 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 des einzuladenden Benutzers
  • firstName(Zeichenfolge, optional) — Vorname des einzuladenden Benutzers
  • lastName(Zeichenfolge, optional) - Nachname des einzuladenden Benutzers
  • groups(Liste der Zeichenketten, optional) — Liste der 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

{
„invitation“: {
„id“: „example-invitation-id“,
 „email“: "foo@example.com
 „, „firstName“: „Beispiel Vorname“,
 „LastName“: „Beispiel Nachname“,
 „Gruppen“: ["Beispielgruppe a“, „Beispielgruppe 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 Ihr Abonnement oder wenden Sie sich an den Support, um dieses Limit zu erhöhen.

Einladungen auflisten

GET /invitations

Anforderungsparameter (Abfragezeichenfolge)

  • limit(Integer, optional) — die maximale Anzahl von Ergebnissen, die in einer einzelnen Antwort zurückgegeben werden sollen (siehe Paginierung); muss zwischen 1 und 100 liegen (der Standardwert ist 50)
  • email(Zeichenfolge, optional) — falls angegeben, senden Sie nur Einladungen für diese E-Mail-Adresse zurück

Beispiel für eine Antwort

{
„invitations“: [
{
„id“: „example-invitation-id-1",
 „email“: "foo@example.com
 „, „firstName“: „Beispiel Vorname 1",
 „LastName“: „Beispiel Nachname 1",
 „Gruppen“: ["Beispielgruppe a“, „Beispielgruppe b"]
},... 
],
 „nächste URL“: "https://url-for-next-page-of-results"
}

Einladung per ID abrufen

GET /invitations/{invitationId}

Beispiel für eine Antwort

{
„id“: „example-invitation-id“,
 „email“: "foo@example.com
 „, „FirstName“: „Beispiel Vorname“,
 „LastName“: „Beispiel Nachname“,
 „Gruppen“: ["Beispielgruppe a“, „Beispielgruppe b"]
}

Endpunktspezifische Fehlercodes

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

Einladungen löschen

DELETE /invitations/{invitationId}

Antwort auf Erfolg

204 „Kein Inhalt“

Endpunktspezifische Fehlercodes

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