API ViaShopModa documentação

leads/cadastrar

Cadastrar lead

Registra um contato (nome e e-mail ou WhatsApp) vindo de um formulário externo, como uma landing page.

Ver como Markdown Baixar coleção Postman Atualizado em 18/11/2026

O que faz #

Cria um lead com origem "api". Recusa se já existir lead com o mesmo WhatsApp (DDI + número) ou o mesmo e-mail.

Requisição #

MétodoPOST
URLhttps://api.viashopmoda.com.br/via/leads/cadastrar/{TOKEN}
CorpoObjeto JSON { ... }, cabeçalho Content-Type: application/json
TokenSubstitua {TOKEN} pelo token da loja. Ele vai no caminho da URL, não em cabeçalho.

Campos #

CampoTipoObrigatórioDescrição
nometextosimNome do contato.
emailtextosimE-mail.
whatsapp_dditextosimDDI, ex.: 55.
whatsapp_numerotextosimNúmero com DDD, ex.: 35988880101.
utm_sourcetextonãoOrigem da campanha.
utm_mediumtextonãoMídia.
utm_campaigntextonãoCampanha.

Exemplo #

Pela API, os quatro primeiros campos são obrigatórios (leads criados pela própria loja podem ter só e-mail ou só WhatsApp).

{
  "nome": "Joana",
  "email": "joana@exemplo.com.br",
  "whatsapp_ddi": "55",
  "whatsapp_numero": "35988880101",
  "utm_source": "instagram",
  "utm_medium": "stories",
  "utm_campaign": "inverno"
}

Sucesso: {"retorno": true, "msg": "Lead cadastrado com sucesso.", "id": "..."}. Duplicado: Lead já existe.

Pode reenviar? #

Sim: o reenvio é recusado com "Lead já existe".