Leads
Leads da pré-venda: contatos que ainda não viraram negócio.
Leads
Recurso do plano: Leads (Pré-vendas).
| Método | Rota | O que faz |
|---|---|---|
GET | /external/v1/leads | Lista com paginação |
GET | /external/v1/leads/:id | Busca um registro pelo ID |
POST | /external/v1/leads | Cria um registro |
PUT | /external/v1/leads/:id | Atualiza um registro |
Listar
Aceita page, limit e relations, como descrito em Paginação e filtros.
curl -G "https://erp-api.ideros.api.br/external/v1/leads" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN" \
--data-urlencode "page=1" \
--data-urlencode "limit=25"
Buscar por ID
curl "https://erp-api.ideros.api.br/external/v1/leads/ID_DO_REGISTRO" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN"
Devolve o registro. Se o ID não existir ou for de outra empresa, a resposta é 200 com corpo {} (objeto vazio).
Criar
Responde 201 com o registro criado.
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
ownerId | string | Não | ID de usuário da empresa. |
workspaceId | string | Não | ID de workspace. |
businessUnitId | string | Não | ID de unidade de negócio. Se não informado, será utilizada a unidade de negócio padrão da empresa. |
leadName | string | Sim | Nome do Lead (Pessoa). |
leadEmail | string | Não | E-mail de contato do Lead. |
leadPhone | string | Não | Telefone de contato do Lead. |
companyName | string | Não | Nome da Empresa do Lead. |
source | string | Não | Origem ou fonte do Lead. |
notes | string | Não | Observações e notas detalhadas sobre o Lead. |
tags | string[] | Não | Tags livres para categorizar o Lead (lista de textos). |
convertedToDealId | string | Não | ID do Deal (Negócio) gerado após a conversão do Lead. |
convertedToPersonId | string | Não | ID da Pessoa criada ou associada após a conversão do Lead. |
curl -X POST "https://erp-api.ideros.api.br/external/v1/leads" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"leadName": "João da Silva",
"leadEmail": "joao@exemplo.com.br",
"companyName": "Tech Solutions Ltda",
"source": "Site"
}'
Atualizar
Envie no corpo só os campos que mudam, com os mesmos nomes da tabela de criação. Responde 200 com o registro atualizado. Registro de outra empresa responde 403; registro inexistente, 404.
Ainda com dúvida?
A nossa equipe ajuda você a configurar e usar esse recurso.