Leads de empresas

Corresponde à tela Leads de empresas. Um lead de empresa guarda a empresa que pode comprar treinamentos, com dados cadastrais, endereço e status. Cada lead tem as abas Contatos, Cursos, Interações, Tarefas e Arquivos. Quando a empresa fecha negócio, o lead pode ser convertido em cliente do cadastro administrativo.

Endpoints

Método	Caminho	Descrição
GET	/crm/business-leads	Lista os leads de empresas
POST	/crm/business-leads	Cadastra um lead de empresa
GET	/crm/business-leads/{uuid}	Consulta um lead de empresa
PUT	/crm/business-leads/{uuid}	Altera um lead de empresa
DELETE	/crm/business-leads/{uuid}	Apaga um lead de empresa
PATCH	/crm/business-leads/{uuid}/convert-to-customer	Converte o lead em cliente
GET	/crm/business-leads/provenances	Lista as procedências (apoio)
GET	/crm/business-leads/statuses	Lista os status de lead (apoio)
GET	/crm/business-leads/users	Lista os usuários (apoio)

GET /crm/business-leads

Lista os leads de empresas da empresa cliente, do mais recente para o mais antigo, pela data de criação.

Parâmetros de URL

Parâmetro	Descrição
search	Texto livre: nome, razão social, CNPJ, e-mail e observações do lead
provenance_id	Id da procedência
provenance	Texto da procedência (contém)
status_id	Id do status do lead
status	Texto do status (contém)
city	Cidade (contém)
state	Estado (contém)
interaction	Texto no tipo de uma interação do lead (contém)
interaction_direction	Texto na direção de uma interação do lead (contém)
interaction_outcome	Texto no resultado de uma interação do lead (contém)
priority	Texto na prioridade de uma tarefa do lead (contém)
contact	Nome de um contato do lead (contém)
customer_vendor	Nome ou razão social do cliente vinculado ao lead (contém)
files	Se informado, traz apenas os leads que têm arquivos enviados
start_date	Data inicial de criação do lead (AAAA-MM-DD)
end_date	Data final de criação do lead (AAAA-MM-DD)
per_page, page	Paginação, conforme Convenções

Exemplo

curl "https://api.pedagogo.app/crm/business-leads?per_page=15&page=1" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>"

Resposta (200): a lista de leads, sem per_page, ou a página de leads, com per_page. Cada lead traz a procedência, o status e os nomes de quem criou e de quem alterou.

POST /crm/business-leads

Cadastra um lead de empresa.

Corpo

Campo	Obrigatório	Tipo	Descrição
name	Sim	texto	Razão social ou nome da empresa
provenance_id	Não	inteiro	Procedência do contato
status_id	Não	inteiro	Status do lead
company_name	Não	texto	Nome fantasia
document	Não	texto	CNPJ da empresa
annual_revenue	Não	número	Receita anual
employee_count	Não	inteiro	Quantidade de funcionários
incorporation_date	Não	data	Data de fundação
phonenumber	Não	texto	Telefone
cellphone	Não	texto	Celular
email	Não	texto	E-mail
zip_code	Não	texto	CEP
street	Não	texto	Logradouro
number	Não	texto	Número
complement	Não	texto	Complemento
neighborhood	Não	texto	Bairro
city	Não	texto	Cidade
state	Não	texto	Estado
observations	Não	texto	Observações

Exemplo

curl -X POST https://api.pedagogo.app/crm/business-leads \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Empresa exemplo Ltda",
    "company_name": "Empresa exemplo",
    "city": "Cidade exemplo",
    "state": "SP"
  }'

Resposta (201): o lead criado, com o uuid.

GET /crm/business-leads/{uuid}

Consulta um lead de empresa. Resposta (200): o lead, com a lista de contatos e o status.

PUT /crm/business-leads/{uuid}

Altera um lead de empresa. Envie apenas os campos que mudam. Aceita os mesmos campos do cadastro, todos opcionais.

Resposta (200): o lead alterado.

DELETE /crm/business-leads/{uuid}

Remove o lead da lista. Resposta (200).

PATCH /crm/business-leads/{uuid}/convert-to-customer

Converte o lead em cliente do cadastro administrativo. A conversão cria o cliente com nome, nome fantasia, CNPJ, telefones e e-mail do lead, copia o endereço e os contatos, e vincula o lead ao cliente criado.

Não há corpo. Resposta (200).

GET /crm/business-leads/provenances

Lista as procedências cadastradas, para o campo provenance_id. Aceita search, per_page e page. Resposta (200): a lista de procedências.

GET /crm/business-leads/statuses

Lista os status de lead cadastrados, para o campo status_id. Aceita search, per_page e page. Resposta (200): a lista de status.

GET /crm/business-leads/users

Lista os usuários da empresa, para o campo de responsável das tarefas. Resposta (200): a lista de usuários.