Envia uma notificação via e-mail com o link para acesso a vídeo chamada
📌 Por que enviar notificações via e-mail?
Realizar envios via e-mail garante que o cliente receba todas as informações importantes e necessárias.
- O cliente pode não possuir um número de telefone.
- Cliente está sem rede em seu celular.
- Reforça a comunicação da empresa.
- Lembra o cliente de um atendimento agendado.
🔗 Endpoint:
Método: POST
URL: https://api.nuvidio.com/v1/api/invite/email
📦 Corpo da Requisição:
{
"email": "[email protected]",
"id": "64c2c8cf165f63af8fd386b1",
"validateIsInviteActive": true
}
🔎 Parâmetros da Requisição:
Parâmetro | Tipo | Obrigatório | Descrição |
---|---|---|---|
string | ✅ | Email para onde será enviada a notificação | |
validateIsInviteActive | boolean | - | Ao enviar essa opção validaremos se o convite ainda é utilizável antes de enviar a notificação (desabilitado, expirado, utilizado) |
id* | string | - | Identificar único do convite |
token* | string | - | Token único do convite |
url* | string | - | URL de acesso à vídeo chamada vinculada ao convite |
É obrigatório informar pelo menos uma das três opções:
id
,token
ouurl
.
✅ Resposta de Sucesso:
202 - Accepted
❌ Respostas de erro:
Código | Mensagem |
---|---|
400 | Convite inutilizável, por isso não é possível notificar o cliente. |
403 | Funcionalidade não habilitada |
404 | Convite não encontrado |
422 | Algum dado está inválido (campo obrigatório faltando ou tipo incorreto) |
500 | Erro interno |