v1Recursos/Team/postConvidar um membro da equipe
Convidar um membro da equipe
Convida um novo membro da equipe por e-mail. O membro convidado é sempre criado com o papel "member" e, a menos que permissions seja informado, a predefinição de permissões padrão de membro — uma chave de API nunca pode convidar alguém como owner ou admin.
post
team:write/api/v1/team/membersCorpo da solicitação
firstNamestringobrigatório
O primeiro nome do novo membro da equipe.
lastNamestringobrigatório
O sobrenome do novo membro da equipe.
emailstringobrigatório
O endereço de e-mail do novo membro da equipe.
permissionsobjectopcional
Flags de acesso por módulo a conceder. Opcional; quando omitido (ou vazio), a predefinição de permissões padrão de membro é usada.
Resposta
dataobjectopcional
userIdstringopcional
ID do membro da equipe recém-convidado.
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
409A solicitação entra em conflito com o estado atual do recurso — por exemplo, alterar o e-mail ou telefone de um destinatário que já recebeu uma mensagem, ou um convite de equipe que já foi aceito (ou que ainda não foi aceito).
422Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
post/api/v1/team/members
Sua chave de API
Corpo da solicitação*
{}