Skip to main content
POST
Enviar Link de Onboarding
A rota POST /messaging/api/v1/services/onboarding-link envia à pessoa o seu link para ela completar a identificação. O envio pode ser por WhatsApp, SMS ou e-mail.
  • A mensagem mostra o nome da sua empresa e leva a pessoa até o seu link.
  • No WhatsApp, a pessoa abre o link por um botão na mensagem.
  • O link enviado vale por 30 dias.
A rota responde na hora e envia a mensagem logo depois.

Request Body

string
required
Canal de envio: whatsapp, sms ou email.Exemplo: whatsapp
string
required
Telefone da pessoa (canais whatsapp e sms), com o código do país e o DDD. Ou e-mail da pessoa (canal email), com até 254 caracteres.Exemplo: +5511999999999
string
required
Nome da sua empresa. Ele aparece na mensagem. Até 64 caracteres, sem link, quebra de linha, tab ou 4 espaços seguidos.Exemplo: Banco X
O seu link, para onde a pessoa vai. Só https, com até 2048 caracteres.Exemplo: https://www.suaempresa.com.br/cadastro/12345

Response

string
Identificador da mensagem.
string
SENT: a mensagem foi aceita para envio.