Skip to main content
POST
Convidar membro para o workspace
string
obrigatório
A chave da API para sua conta. Você pode encontrá-la nas configurações da conta.
Requer uma chave de API com o escopo workspaces:manage. Adiciona um membro a um workspace usando um código de curta duração obtido em Obter código de convite: o usuário convidado é identificado pelo código, e quem faz a chamada define a função dele com group. Somente o dono do workspace pode chamar este endpoint, e o número de membros é limitado pelo plano do dono. A função em group define o que o membro pode fazer nas aplicações compartilhadas do workspace: veja Funções. Altere uma função depois com Alterar permissões. Um dono não pode convidar a si mesmo. Limitado a 1 adição a cada 5 segundos por usuário.

Funções

O dashboard mostra cada função pelo nome, e a API recebe o valor da coluna group. O dono do workspace aparece nas listas de membros com group: "owner" e sempre tem acesso total. owner não pode ser atribuído.

Parâmetros

string
obrigatório
O ID do workspace.
string
obrigatório
Uma string com o código de convite do membro.
string
obrigatório
A função do membro: view, manager, maintain ou admin. Veja Funções.

Resposta

string
Indica se a chamada foi bem-sucedida: success se foi, error se não.

Erros comuns

Relacionados