v1
latestOpenAPI 3.0.12026-07-261451591021.8 KBEnviar Convite
Convites- Enviar Convite<br/>Permite que seja convidado novos usuários para se cadastrarem e utilizarem a plataforma. Ao enviar um convite, é fornecido ao destinatário um link único que o direciona para o processo de criação de conta.<br/><br/>Funcionalidades do Endpoint:<br/>- Criação de Convites Individuais: Envie convites personalizados para cada usuário, definindo seu endereço de email e outros atributos relevantes.<br/>- Validade dos Convites: Estabeleça um período de tempo para que os convites sejam válidos, evitando que links expirados sejam utilizados.<br/>- Monitoramento de Conversões: Acompanhe a taxa de conversão dos convites enviados, identificando quantos usuários se cadastraram através desse método.<br/><br/>Requisição<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th><th>Obrigatoriedade</th></tr></thead><tbody><tr><td>name</td><td>Texto</td><td>Nome do usuário cadastrado</td><td>Sim</td></tr><tr><td>cnpj</td><td>Texto</td><td>CNPJ do usuário cadastrado</td><td>Sim</td></tr><tr><td>email</td><td>Texto</td><td>E-mail do usuário cadastrado</td><td>Sim</td></tr><tr><td>flow</td><td>Texto</td><td>Tipo de conta (conta_rapida, conta_rapida_cobranca)</td><td>Não</td></tr><tr><td>client_type</td><td>Texto</td><td>Categoria da conta (cedente, cessionario)</td><td>Não</td></tr></tbody></table><br/><br/>Resposta<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>Message</td><td>Texto</td><td>Mensagem de envio de convite</td></tr></tbody></table>
Headers
Client ID enviado no Header
Request body
Example request
{
"name": "Razão Social",
"cnpj": "00.000.000/0001-00",
"email": "example@email.com",
"flow": "conta_rapida/conta_rapida_cobranca",
"client_type": "cedente/cessionario"
}Response
Invitation created successfully
Example response
{
"message": "Email de convite enviado com sucesso"
}