Interações do lead de empresa
Corresponde à aba Interações da tela Leads de empresas. Guarda o histórico de contatos com a empresa do lead: o tipo do contato, a direção, o resultado e as notas.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /crm/business-leads/{business_lead_uuid}/interactions | Lista as interações do lead |
| POST | /crm/business-leads/{business_lead_uuid}/interactions | Registra uma interação |
| GET | /crm/business-leads/{business_lead_uuid}/interactions/{id} | Consulta uma interação |
| PUT | /crm/business-leads/{business_lead_uuid}/interactions/{id} | Altera uma interação |
| DELETE | /crm/business-leads/{business_lead_uuid}/interactions/{id} | Apaga uma interação |
| GET | /crm/business-leads/interactions-directions | Lista as direções de interação (apoio) |
| GET | /crm/business-leads/interactions-outcomes | Lista os resultados de interação (apoio) |
GET /crm/business-leads/{business_lead_uuid}/interactions
Lista as interações do lead.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
| search | Texto nas notas da interação |
| per_page, page | Paginação, conforme Convenções |
Resposta (200): a lista de interações, com o nome do resultado, da direção, da tarefa vinculada, quando houver, e do contato, e os nomes de quem criou e de quem alterou.
POST /crm/business-leads/{business_lead_uuid}/interactions
Registra uma interação com o lead.
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| interaction_type | Sim | texto | Tipo do contato, escrito livremente (por exemplo, ligação ou e-mail) |
| direction_id | Sim | inteiro | Direção do contato (id da lista de direções) |
| outcome_id | Não | inteiro | Resultado do contato (id da lista de resultados) |
| contact_id | Não | inteiro | Pessoa de contato do lead (id do contato) |
| notes | Não | texto | Notas sobre o contato |
| due_at | Não | data e hora | Data e hora de uma tarefa de retorno, criada junto com a interação |
Quando due_at é informado, o sistema cria uma tarefa vinculada à interação,
com vencimento e lembrete nessa data e hora. O assunto da tarefa é o nome do
resultado, se houver, ou Retorno de contato. Se houver contact_id, o nome do
contato é acrescentado ao assunto, separado por -.
Exemplo
curl -X POST https://api.pedagogo.app/crm/business-leads/<uuid-do-lead>/interactions \
-H "Accept: application/json" \
-H "Authorization: Bearer <token-de-sessao>" \
-H "Content-Type: application/json" \
-d '{
"interaction_type": "Ligação",
"direction_id": 1,
"outcome_id": 1,
"notes": "Pediu uma proposta para a próxima semana.",
"due_at": "2026-11-18 09:00:00"
}'
Resposta (201): a interação registrada.
PUT /crm/business-leads/{business_lead_uuid}/interactions/{id}
Altera uma interação. Envie apenas os campos que mudam.
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| interaction_type | Não | texto | Tipo do contato |
| direction_id | Não | inteiro | Direção do contato |
| outcome_id | Não | inteiro | Resultado do contato |
| notes | Não | texto | Notas sobre o contato |
Resposta (200): a interação alterada.
Consultar e apagar
GET /crm/business-leads/{business_lead_uuid}/interactions/{id} traz a
interação. DELETE /crm/business-leads/{business_lead_uuid}/interactions/{id}
remove a interação. Se ela tiver uma tarefa vinculada, a tarefa também é removida.
Resposta (200).
GET /crm/business-leads/interactions-directions
Lista as direções de interação cadastradas, para o campo direction_id. Aceita
search, per_page e page. Resposta (200): a lista de direções.
GET /crm/business-leads/interactions-outcomes
Lista os resultados de interação cadastrados, para o campo outcome_id. Aceita
search, per_page e page. Resposta (200): a lista de resultados.