logo
UsuáriosCriar Convite

Criar Convite

Envia um convite para um novo usuário se juntar à empresa. O convite é enviado para o e-mail informado com o papel (role) especificado.

Regras:

  • O roleId deve ser um UUID v4 válido de um papel existente na empresa.
  • O email deve ser um endereço de e-mail válido.
  • Não é possível enviar convite para um e-mail que já possui convite pendente ou que já está vinculado à empresa.
curl -X POST "https://api-sandbox.contasimples.com/users/v1/invites" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "roleId": "550e8400-e29b-41d4-a716-446655440000",
  "email": "user@company.com"
}'
{
  "message": "Invite created."
}
POST
/users/v1/invites
POST
Bearer Token
Bearer Tokenstring
Required

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer {token}

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer {token}
Content-Typestring
Required

The media type of the request body

Options: application/json
roleIdstring
Required

Identificador único do papel (role) a ser atribuído ao usuário convidado. Deve ser um UUID v4 válido.

Format: uuid
emailstring
Required

Endereço de e-mail para o qual o convite será enviado.

Format: email
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer \{token\}

Body

application/json
roleIdstring
Required

Identificador único do papel (role) a ser atribuído ao usuário convidado. Deve ser um UUID v4 válido.

emailstring
Required

Endereço de e-mail para o qual o convite será enviado.

Responses