Przejdź do nawigacji
Obszar roboczyWorkspaceInvites

Zaproś użytkownika

Wysyła zaproszenie e-mail do dołączenia do twojego obszaru roboczego na podany adres. Jeśli użytkownik nie ma konta, zostanie poproszony o jego utworzenie. Jeśli zaakceptuje zaproszenie, zostanie dodany do obszaru roboczego i subskrypcji, wykorzystując jedno z twoich miejsc. Ten endpoint mogą wywoływać tylko członkowie obszaru roboczego z uprawnieniem WORKSPACE_MEMBERS_INVITE. Jeśli użytkownik jest już w obszarze roboczym, zwrócony zostanie błąd 400.

Nagłówki

xi-api-keystringOpcjonalny

Żądanie

This endpoint expects an object.
emailstringWymagany

E-mail klienta

seat_typeenum or nullOpcjonalny

Typ miejsca użytkownika

Dozwolone wartości:
group_idslist of strings or nullOpcjonalny

ID grup użytkownika

usage_limitinteger or nullOpcjonalny>=0

Miesięczny limit użycia kredytów dla zapraszanej osoby. Pomiń lub ustaw null, aby nie stosować własnego limitu.

workspace_permissionstring or nullOpcjonalnyDeprecated

Uprawnienie użytkownika w workspace’ie. To pole jest przestarzałe, użyj zamiast niego seat_type.

Odpowiedź

Pomyślna odpowiedź

statusstring

Status żądania zaproszenia do workspace. Jeśli żądanie się powiedzie, status będzie mieć wartość „ok”. W przeciwnym razie zostanie zwrócony komunikat o błędzie ze statusem 500.

Błędy

422
Unprocessable Entity Error