post https://example.com/api/v1/invitation
Convites- Enviar Convite
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.
Funcionalidades do Endpoint:
- Criação de Convites Individuais: Envie convites personalizados para cada usuário, definindo seu endereço de email e outros atributos relevantes.
- Validade dos Convites: Estabeleça um período de tempo para que os convites sejam válidos, evitando que links expirados sejam utilizados.
- Monitoramento de Conversões: Acompanhe a taxa de conversão dos convites enviados, identificando quantos usuários se cadastraram através desse método.
Requisição
| Campo | Tipo | Descrição | Obrigatoriedade |
|---|---|---|---|
| name | Texto | Nome do usuário cadastrado | Sim |
| cnpj | Texto | CNPJ do usuário cadastrado | Sim |
| Texto | E-mail do usuário cadastrado | Sim | |
| contaCobranca | Booleano | Identificador se é ou não uma conta cobrança | Sim |
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| Message | Texto | Mensagem de envio de convite |