Hoppa till navigering
ArbetsytaWorkspaceInvites

Bjud in användare

Skickar en e-postinbjudan till den angivna e-postadressen för att gå med i din arbetsyta. Om användaren inte har ett konto uppmanas hen att skapa ett. Om användaren accepterar inbjudan läggs hen till som användare i din arbetsyta och din prenumeration, vilket använder en av dina platser. Den här endpointen får bara anropas av medlemmar i arbetsytan med behörigheten WORKSPACE_MEMBERS_INVITE. Om användaren redan finns i arbetsytan returneras ett 400-fel.

Headers

xi-api-keystringValfri

Förfrågan

This endpoint expects an object.
emailstringObligatorisk

Kundens e-postadress

seat_typeenum or nullValfri

Användarens platstyp

Tillåtna värden:
group_idslist of strings or nullValfri

Användarens grupp-ID:n

usage_limitinteger or nullValfri>=0

Månatlig gräns för kreditanvändning för den inbjudna. Utelämna eller ange null för ingen anpassad gräns.

workspace_permissionstring or nullValfriDeprecated

Användarens behörighet i arbetsytan. Detta är inaktuellt, använd seat_type i stället.

Svar

Lyckat svar
statusstring

Status för begäran om att bjuda in till arbetsytan. Om begäran lyckades är statusen 'ok'. Annars returneras ett felmeddelande med status 500.

Fel

422
Unprocessable Entity Error