Zur Navigation springen
WorkspaceWorkspaceInvites

Mehrere Benutzer einladen

Sendet E-Mail-Einladungen zum Beitritt zu Ihrem Workspace an die angegebenen E-Mail-Adressen. Alle E-Mail-Adressen müssen zu einer verifizierten Domain gehören. Wenn die Benutzer kein Konto haben, werden sie aufgefordert, eines zu erstellen. Nehmen sie die Einladungen an, werden sie mit einem Ihrer Seats als Benutzer zu Ihrem Workspace und Abonnement hinzugefügt. Dieser Endpoint kann nur von Workspace-Mitgliedern mit der Berechtigung WORKSPACE_MEMBERS_INVITE aufgerufen werden.

Header

xi-api-keystringOptional

Anfrage

This endpoint expects an object.
emailslist of stringsErforderlich

Die E-Mail-Adresse des Kunden

seat_typeenum or nullOptional

Der Seat-Typ des Benutzers

Erlaubte Werte:
group_idslist of strings or nullOptional

Die Gruppen-IDs des Benutzers

usage_limitinteger or nullOptional>=0

Monatliches Credit-Nutzungslimit für die eingeladene Person. Weglassen oder auf null setzen, um kein benutzerdefiniertes Limit festzulegen.

Antwort

Erfolgreiche Antwort
statusstring

Der Status der Workspace-Einladungsanfrage. Bei Erfolg ist der Status „ok“. Andernfalls wird eine Fehlermeldung mit Status 500 zurückgegeben.

Fehler

422
Unprocessable Entity Error