Ir para a navegação
Espaço de trabalhoWorkspaceInvites

Convidar usuário

Envia um convite por e-mail para entrar no seu espaço de trabalho ao endereço fornecido. Se o usuário não tiver uma conta, será solicitado que crie uma. Se aceitar o convite, ele será adicionado como usuário ao seu espaço de trabalho e à sua assinatura, usando um dos seus assentos. Este endpoint só pode ser chamado por membros do espaço de trabalho com a permissão WORKSPACE_MEMBERS_INVITE. Se o usuário já estiver no espaço de trabalho, será retornado um erro 400.

Cabeçalhos

xi-api-keystringOpcional

Solicitação

This endpoint expects an object.
emailstringObrigatório

O e-mail do cliente

seat_typeenum or nullOpcional

O tipo de assento do usuário

Valores permitidos:
group_idslist of strings or nullOpcional

Os IDs dos grupos do usuário

usage_limitinteger or nullOpcional>=0

Limite mensal de uso de créditos para a pessoa convidada. Omita ou defina como null para não aplicar um limite personalizado.

workspace_permissionstring or nullOpcionalDeprecated

A permissão do usuário no workspace. Isso está obsoleto; use seat_type.

Resposta

Resposta bem-sucedida

statusstring

O status da solicitação de convite para o espaço de trabalho. Se a solicitação for bem-sucedida, o status será ‘ok’. Caso contrário, será retornada uma mensagem de erro com status 500.

Erros

422
Unprocessable Entity Error