Endpoint para Recebimento de Leads

O endpoint integracao.softunico.com.br/{identificador}/webhook/leads permite que leads sejam enviados para a plataforma SoftUnico via método HTTP POST utilizando dados em formato JSON. Abaixo estão os detalhes dos campos aceitos e das diretrizes para utilização deste endpoint.

URL do Endpoint

				
					POST https://integracao.softunico.com.br/{identificador}/webhook/leads
O {identificador} é um identificador único atribuído a cada empresa no CRM Softunico. Para encontrar o identificador da sua empresa, siga os passos abaixo:
  1. Acesse o Softunico.
  2. Na URL do navegador, localize a parte da URL após softunico.com.br/. Por exemplo, se a URL for https://app.softunico.com.br/exemplo/dashboard, o identificador será exemplo.

Dados Aceitos (JSON)

Os dados a seguir devem ser enviados no corpo da requisição HTTP em formato JSON:

  • name (obrigatório): Nome do lead.
  • email (opcional): Email do lead. Se fornecido, deve ser um formato de email válido.
  • phone (opcional): Telefone do lead. Deve ser fornecido se o email não estiver presente ou for inválido.
  • reference (opcional): Código de referência do imóvel associado ao lead.
  • message (opcional): Mensagem de contato ou informações adicionais fornecidas pelo lead.

Requisitos e Validações

  • O campo name é obrigatório. Se não for fornecido, a requisição será rejeitada com um erro 400 Bad Request.
  • O campo email é opcional, mas se fornecido, deve estar em um formato válido de endereço de email.
  • O campo phone é opcional, mas deve ser fornecido se o campo email não estiver presente ou for inválido. Inclua o código de área junto com o número.
  • Outros campos, como reference e message, são opcionais e podem ser fornecidos conforme necessário.

Exemplo de Corpo da Requisição (JSON)

				
					{
  "name": "John Doe",
  "email": "johndoe@example.com",
  "phone": "11999995555",
  "reference": "REF12345",
  "message": "Interessado no imóvel listado"
}

Respostas da API

  • 200 OK: A requisição foi processada com sucesso.
  • 400 Bad Request: A requisição está faltando o campo obrigatório name ou contém um email inválido sem o número de telefone correspondente.

Exemplo de Uso (cURL)

				
					curl -X POST \
  https://integracao.softunico.com.br/{identificador}/webhook/leads \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "John Doe",
    "email": "johndoe@example.com",
    "phone": "123456789",
    "reference": "REF12345",
    "message": "Interessado no imóvel listado"
  }'

Observações Adicionais

Certifique-se de substituir {identificador} na URL com o identificador real da sua empresa para que a requisição seja roteada corretamente para o seu sistema na plataforma SoftUnico.

Para qualquer dúvida ou problema relacionado ao uso deste endpoint, entre em contato com o suporte técnico da SoftUnico.

Esta documentação fornece uma visão geral do endpoint para envio de leads. Certifique-se de seguir as diretrizes acima para garantir o correto processamento das requisições e evitar erros de validação.