Skip to main content
POST
Enviar convites

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Payload para criar um ou mais convites (um por e-mail), com papéis e permissões de acesso a funis.

emails
string<email>[]

Lista de e-mails que receberão convite. Cada e-mail gera um convite dentro da mesma requisição.

Endereço de e-mail do convidado.

role_ids
integer[]

Lista de IDs de papéis atribuídos ao convidado ao aceitar o convite. Cada ID precisa ser de um papel global ou da empresa atual. Enviar este campo exige a permissão Editar, criar papéis e permissões e atribuir usuários. Uma Aplicação (token de API) pode criar o convite, mas não pode incluir role_ids — nesse caso a resposta é 403 com permission_required. Incluir o papel Property só é aceito quando quem autentica já tem Property na empresa.

ID do papel a ser associado ao convidado.

funnel_access
object[]

Lista de permissões por funil que o convidado terá ao aceitar o convite.

Response

Sucesso

response
boolean
invites
object[]