Imobilead

https://imobilead.me/docs
Admin
Imobilead is a real estate lead management platform that enables capturing leads from external...
Tokens:6,712
Snippets:43
Trust Score:6.2
Update:1 month ago
Show doc for...
Tokens:
Raw
### Complete curl example with authentication

Source: https://imobilead.me/docs/callback

A full curl command that updates a lead with all updatable fields. Requires a valid token and an existing lead_id.

```bash
curl -X POST "https://seu-dominio.com/callback/" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer seu-token-de-integracao" \
  -d '{
    "lead_id": "imd-102938",
    "status": "em-atendimento",
    "broker_email": "lucas@imobiliaria.com",
    "notes": "Cliente pediu visita no sabado pela manha.",
    "tags": ["prioridade-alta", "visita-agendada"],
    "appointment_at": "2026-04-20T14:00:00Z",
    "external_reference": "crm-55421"
  }'
```

--------------------------------

### Send lead via curl

Source: https://imobilead.me/docs/webhook

Example curl request to send a lead. The payload includes nome, email, telefone, produto, and observacao. Ensure Content-Type is application/json.

```bash
curl -X POST "https://app.imobilead.me/integrate-api/integracoes/webhook/{SEU-CODIGO}" \
  -H "Content-Type: application/json" \
  -d '{
    "nome": "Nome do lead",
    "email": "emaildolead@example.com",
    "telefone": "62983282136",
    "produto": "produto-de-interesse",
    "observacao": "Observação ou mensagem do lead"
}'
```

--------------------------------

### POST /callback/

Source: https://imobilead.me/docs/callback

Atualiza um lead existente no Imobilead. É necessário autenticação via token Bearer no header Authorization. O corpo deve conter o lead_id e ao menos um campo de atualização.

```APIDOC
## POST /callback/

### Description
Atualiza um lead existente no Imobilead, permitindo modificar status, corretor, notas, tags, agendamento e referência externa.

### Method
POST

### Endpoint
https://seu-dominio.com/callback/

### Headers
- **Authorization** (string) - Obrigatório - Token Bearer para autenticação, no formato `Bearer seu-token-de-integracao`.
- **Content-Type** (string) - Obrigatório - `application/json`

### Request Body
| Campo | Tipo | Obrigatório | Descrição |
|-------|------|-------------|------------|
| `lead_id` | string | Sim | Identificador do lead dentro do Imobilead. |
| `status` | string | Não | Novo status comercial, como "novo", "em-atendimento", "ganho" ou "perdido". |
| `broker_email` | string | Não | Corretor responsável pela continuidade do atendimento. |
| `notes` | string | Não | Observações operacionais adicionadas ao lead. |
| `tags` | array | Não | Lista de tags para classificação e automações. |
| `appointment_at` | datetime | Não | Data e hora de agendamento, quando houver. |
| `external_reference` | string | Não | Chave do sistema externo para conciliação. |

Obrigatório: enviar sempre `lead_id` com pelo menos um campo de atualização.

### Request Example
curl -X POST "https://seu-dominio.com/callback/" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer seu-token-de-integracao" \
  -d '{
    "lead_id": "imd-102938",
    "status": "em-atendimento",
    "broker_email": "lucas@imobiliaria.com",
    "notes": "Cliente pediu visita no sábado pela manhã.",
    "tags": ["prioridade-alta", "visita-agendada"],
    "appointment_at": "2026-04-20T14:00:00Z",
    "external_reference": "crm-55421"
  }'

### Response - Success (200)
- **success** (boolean) - Indica se a operação foi bem-sucedida.
- **message** (string) - Mensagem de confirmação.
- **lead_id** (string) - Identificador do lead atualizado.

#### Response Example
{
  "success": true,
  "message": "Lead atualizado com sucesso.",
  "lead_id": "imd-102938"
}

### Error Responses
- **401 Token ausente**: O header `Authorization` não foi enviado ou está vazio.
- **403 Token inválido**: O token informado não pertence ao ambiente configurado ou foi revogado.
- **419 Token expirado**: Renove a credencial no painel e atualize o segredo no sistema integrador.
- **404 Lead não encontrado**: O `lead_id` informado não existe ou não pertence ao contexto da integração.

```

--------------------------------

### POST /integrate-api/integracoes/webhook/{SEU-CODIGO}

Source: https://imobilead.me/docs/webhook

Endpoint para envio de leads via webhook para o Imobilead. Aceita payload JSON com campos de lead e retorna confirmação.

```APIDOC
## POST /integrate-api/integracoes/webhook/{SEU-CODIGO}

### Description
Envia leads de fontes externas, como portais, formulários de captação e campanhas de mídia, diretamente para o Imobilead. Cada integração gera uma URL própria no momento da criação do tipo Webhook no painel.

### Method
POST

### Endpoint
POST https://app.imobilead.me/integrate-api/integracoes/webhook/{SEU-CODIGO}

### Parameters
#### Path Parameters
- **SEU-CODIGO** (string) - Required - Código gerado pelo Imobilead ao criar a integração Webhook no painel.

#### Request Body
- **nome** (string) - Required - Nome do lead.
- **email** (string) - Optional - Email do lead.
- **telefone** (string) - Required - Telefone do lead com DDD.
- **produto** (string) - Optional - Produto ou imóvel de interesse informado na origem.
- **observacao** (string) - Optional - Observação ou mensagem enviada pelo lead.

### Request Example
```
curl -X POST "https://app.imobilead.me/integrate-api/integracoes/webhook/{SEU-CODIGO}" \
  -H "Content-Type: application/json" \
  -d '{
    "nome": "Nome do lead",
    "email": "emaildolead@example.com",
    "telefone": "62983282136",
    "produto": "produto-de-interesse",
    "observacao": "Observação ou mensagem do lead"
}'
```

### Response
#### Success Response (200)
- **message** (string) - Confirmação de recebimento.

#### Response Example
```
{
    "message": "okay"
}
```

### Error Handling
- **400** - Payload inválido: campos obrigatórios não enviados ou JSON malformado.
- **415** - Content-Type incorreto: envie `Content-Type: application/json`.
- **422** - Dados inconsistentes: email e telefone ausentes ou com formato inválido.
- **500** - Falha no processamento: erro interno temporário; implemente retentativa controlada.
```

--------------------------------

### Exemplo de payload do lead (com e-mail e origem Meta)

Source: https://imobilead.me/docs/troca-status

Primeiro exemplo de corpo JSON enviado no POST, com dados fictícios. Inclui campos como id, nome, email, produto, telefone, tag, created_at, entre outros. O campo 'email' está vazio e 'facebook_leadgen_id' preenchido.

```json
{
    "id": "a1b2c3d4-0000-4a1b-8c2d-000000000001",
    "nome": "Fulano de Tal",
    "email": "",
    "produto": "EMPREENDIMENTO EXEMPLO",
    "telefone": "+5581999990000",
    "tag": null,
    "created_at": "2026-07-22T04:37:44.000Z",
    "nova_data": "2026-07-22T04:37:44.000Z",
    "data_reativacao": null,
    "leadTransferedAt": null,
    "leadId": "a1b2c3d4-0000-4a1b-8c2d-000000000001",
    "facebook_leadgen_id": "0000000000000000",
    "previousUsers": [59000],
    "pipelineStatusId": "42ce9246-0000-4f0d-8312-000000000002",
    "pipelineStatus": "Em Atendimento",
    "produto_id": 176164,
    "user": {
        "nome": "Corretor Exemplo da Silva",
        "email": "corretor.exemplo@email.com",
        "whatsapp": "81999990000"
    },
    "status": "Em Atendimento",
    "statusId": "42ce9246-0000-4f0d-8312-000000000002"
}
```

--------------------------------

### Exemplo de payload do lead (com tag, sem e-mail e sem origem Meta)

Source: https://imobilead.me/docs/troca-status

Segundo exemplo de corpo JSON enviado no POST, com dados fictícios. Inclui campos como id, nome, email, produto, telefone, tag, created_at, entre outros. O campo 'email' é null, 'tag' é preenchido e 'facebook_leadgen_id' é null.

```json
{
    "id": "66ebe352-0000-4310-8c6f-000000000005",
    "nome": "Beltrano Souza",
    "email": null,
    "produto": "RESIDENCIAL MODELO",
    "telefone": "+5581988880000",
    "tag": "novo",
    "created_at": "2026-07-22T13:29:19.000Z",
    "nova_data": "2026-07-22T13:29:19.000Z",
    "data_reativacao": null,
    "leadTransferedAt": null,
    "leadId": "66ebe352-0000-4310-8c6f-000000000005",
    "facebook_leadgen_id": null,
    "previousUsers": [59330],
    "pipelineStatusId": "3e9fbd1b-0000-4944-b3af-000000000006",
    "pipelineStatus": "Visita Agendada",
    "produto_id": 175411,
    "user": {
        "nome": "Corretora Exemplo Pereira",
        "email": "corretora.exemplo@email.com",
        "whatsapp": "81988880000"
    },
    "status": "Visita Agendada",
    "statusId": "3e9fbd1b-0000-4944-b3af-000000000006"
}
```

--------------------------------

### Resposta de sucesso do endpoint externo (JSON)

Source: https://imobilead.me/docs/integracao-saida

Resposta esperada do endpoint externo para confirmar o recebimento do lead. Deve retornar status HTTP de sucesso, preferencialmente `200 OK` ou `201 Created`, junto com este JSON simples.

```json
{
  "success": true,
  "message": "Lead recebido pelo sistema externo.",
  "external_reference": "crm-55421"
}
```

--------------------------------

### Expected success response

Source: https://imobilead.me/docs/callback

The JSON response returned when the lead is updated successfully.

```json
{
  "success": true,
  "message": "Lead atualizado com sucesso.",
  "lead_id": "imd-102938"
}
```

--------------------------------

### Success response

Source: https://imobilead.me/docs/webhook

Expected response when the lead is successfully received.

```json
{
    "message": "okay"
}
```

--------------------------------

### Payload de saída do Imobilead (JSON)

Source: https://imobilead.me/docs/integracao-saida

Payload JSON enviado pelo Imobilead para o endpoint externo quando um lead atende ao critério definido na operação. Inclui dados do lead, identificador único `id` e objeto `user` com dados do corretor responsável.

```json
{
    "nome": "Lead de Teste",
    "email": "emaildolead@example.com",
    "telefone": "5562983282136",
    "produto": "Nome do produto de interesse",
    "id_portal": 144810,
    "notas": "Notas do lead",
    "id": "b0609d8d-195c-413f-8d74-7508ffe8d3d3",
    "user": {
        "nome": "Nome do usuário",
        "email": "usuario@gmail.com",
        "whatsapp": "+5511999999999"
    }
}
```

--------------------------------

### Webhook endpoint

Source: https://imobilead.me/docs/webhook

Endpoint for sending leads to Imobilead. The {SEU-CODIGO} is generated when creating a Webhook integration in the panel. Use this URL in the lead source platform.

```http
POST https://app.imobilead.me/integrate-api/integracoes/webhook/{SEU-CODIGO}
```

--------------------------------

### POST endpoint URL

Source: https://imobilead.me/docs/callback

The endpoint URL for updating an existing lead. Requires a POST request with token authentication.

```http
POST https://seu-dominio.com/callback/
```

--------------------------------

### Authorization header format

Source: https://imobilead.me/docs/callback

The token must be sent in the Authorization header using the Bearer scheme.

```http
Authorization: Bearer seu-token-de-integracao
```
Tokens:
Raw