Skip to navigation
WorkspaceWorkspaceInvites

Gebruiker uitnodigen

Verstuurt een e-mailuitnodiging om lid te worden van je workspace naar het opgegeven e-mailadres. Als de gebruiker geen account heeft, wordt gevraagd er een te maken. Als de gebruiker deze uitnodiging accepteert, wordt die als gebruiker toegevoegd aan je workspace en je abonnement, waarbij een van je seats wordt gebruikt. Dit endpoint kan alleen worden aangeroepen door workspaceleden met de machtiging WORKSPACE_MEMBERS_INVITE. Als de gebruiker al in de workspace zit, wordt een 400-fout geretourneerd.

Headers

xi-api-keystringOptional

Request

This endpoint expects an object.
emailstringRequired

Het e-mailadres van de klant

seat_typeenum or nullOptional

Het seat-type van de gebruiker

Allowed values:
group_idslist of strings or nullOptional

De groeps-ID’s van de gebruiker

usage_limitinteger or nullOptional>=0
Monthly credit usage limit for the invitee. Omit or set to null for no custom cap.
workspace_permissionstring or nullOptionalDeprecated

De workspace-machtiging van de gebruiker. Dit is verouderd; gebruik in plaats daarvan seat_type.

Response

Geslaagde response
statusstring
De status van het verzoek om een uitnodiging voor de workspace. Als het verzoek is geslaagd, is de status 'ok'. Anders wordt een foutmelding met status 500 geretourneerd.

Errors

422
Unprocessable Entity Error