Hoppa till navigering

Bjud in flera användare

Skickar e-postinbjudningar till de angivna e-postadresserna för att gå med i din arbetsyta. Kräver att alla e-postadresser tillhör en verifierad domän. Om användarna inte har ett konto uppmanas de att skapa ett. Om användarna accepterar inbjudningarna läggs de 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.

Headers

xi-api-keystringValfri

Förfrågan

This endpoint expects an object.
emailslist of stringsObligatorisk

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.

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