For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DocumentaçãoReferência da API
DocumentaçãoReferência da API
  • Integrações privadas
  • Entrada pública de leads
      • POSTReceber lead externo
LogoLogo
Entrada pública de leadsWebhook

Receber lead externo

||View as Markdown|
POST
/api_lead/lead
POST
/ords/gestao/api_lead/lead
$curl -X POST https://gestao.simplificagestao.com.br/ords/gestao/api_lead/lead \
>     -H "x-api-key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "nome": "Matheus Botelho",
>  "origem": "Instagram",
>  "celular": "11991234567"
>}'
1{
2  "status": "sucesso",
3  "mensagem": "Lead recebido"
4}
Recebe um lead externo em JSON, valida a `x-api-key` e coloca esse payload na fila operacional do Simplifica. Como usar: - envie a chamada para `/api_lead/lead`; - informe a credencial pública em `x-api-key`; - envie um body JSON válido; - use os campos `nome`, `origem` e `celular` como base mínima recomendada. Regras importantes: - envie os nomes dos campos em minúsculas; - `consultor`, quando enviado, deve ser o e-mail do consultor; - se a `origem` não existir, o Simplifica cria a origem e continua o cadastro; - continue enviando `origem` preenchida; a documentação não trata valor vazio como caminho normal de integração; - se `consultor` não for enviado, o Simplifica tenta definir automaticamente um responsável; - `cpf` e `cnpj` não devem ser enviados juntos. Regra de responsável quando `consultor` não vier no payload: 1. lista da vez da empresa; 2. usuário marcado como SDR; 3. usuário marcado como closer; 4. primeiro usuário encontrado. Contrato HTTP síncrono atual: - `200` quando o payload é aceito e enfileirado; - `400` quando o JSON é inválido ou o body está ausente; - `401` quando a credencial é inválida; - `500` em erro técnico inesperado. Regras de negócio adicionais, deduplicação e conflitos de identificação acontecem no processamento interno posterior e não retornam hoje um payload síncrono detalhado.
Was this page helpful?
Previous

Listar assinaturas por oportunidade

Built with

Recebe um lead externo em JSON, valida a x-api-key e coloca esse payload na fila operacional do Simplifica.

Como usar:

  • envie a chamada para /api_lead/lead;
  • informe a credencial pública em x-api-key;
  • envie um body JSON válido;
  • use os campos nome, origem e celular como base mínima recomendada.

Regras importantes:

  • envie os nomes dos campos em minúsculas;
  • consultor, quando enviado, deve ser o e-mail do consultor;
  • se a origem não existir, o Simplifica cria a origem e continua o cadastro;
  • continue enviando origem preenchida; a documentação não trata valor vazio como caminho normal de integração;
  • se consultor não for enviado, o Simplifica tenta definir automaticamente um responsável;
  • cpf e cnpj não devem ser enviados juntos.

Regra de responsável quando consultor não vier no payload:

  1. lista da vez da empresa;
  2. usuário marcado como SDR;
  3. usuário marcado como closer;
  4. primeiro usuário encontrado.

Contrato HTTP síncrono atual:

  • 200 quando o payload é aceito e enfileirado;
  • 400 quando o JSON é inválido ou o body está ausente;
  • 401 quando a credencial é inválida;
  • 500 em erro técnico inesperado.

Regras de negócio adicionais, deduplicação e conflitos de identificação acontecem no processamento interno posterior e não retornam hoje um payload síncrono detalhado.

Authentication

x-api-keystring

Chave pública usada para enviar leads externos ao Simplifica.

Request

This endpoint expects an object.
nomestringRequired
Nome completo do lead.
origemstringRequired

Origem principal do lead. Se não existir, o Simplifica cria automaticamente. Este continua sendo um campo obrigatório no payload documentado e deve ser enviado preenchido.

celularstringRequired

Número de celular com DDD. Aceita envio com ou sem formatação. O +55 é completado automaticamente quando necessário.

consultorstringOptional

E-mail do consultor responsável. Se omitido, o Simplifica tenta definir automaticamente um responsável.

telefone_fixostringOptional

Telefone fixo com DDD. Aceita envio com ou sem formatação. O +55 é completado automaticamente quando necessário.

emailstringOptional

E-mail do lead.

cpfstringOptional

CPF do lead, quando aplicável. Não envie junto com cnpj.

cnpjstringOptional

CNPJ do lead, quando aplicável. Não envie junto com cpf.

custommap from strings to anyOptional

Objeto JSON livre com dados personalizados. A estrutura original é preservada.

Response

Payload recebido com sucesso e enfileirado para processamento.
statusenum
Allowed values:
mensagemstring

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error