Zur Navigation springen
WorkspaceWorkspaceInvites

Benutzer einladen

Sendet eine E-Mail-Einladung zum Beitritt zu Ihrem Workspace an die angegebene E-Mail-Adresse. Wenn der Benutzer kein Konto hat, wird er aufgefordert, eines zu erstellen. Nimmt der Benutzer die Einladung an, wird er 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. Befindet sich der Benutzer bereits im Workspace, wird ein Fehler 400 zurückgegeben.

Header

xi-api-keystringOptional

Anfrage

This endpoint expects an object.
emailstringErforderlich

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.

workspace_permissionstring or nullOptionalDeprecated

Die Workspace-Berechtigung des Nutzers. Dies ist veraltet, verwenden Sie stattdessen seat_type.

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