Interações com clientes

Corresponde à tela Interações. Registra os contatos feitos com clientes que já estão cadastrados, com o cliente, a pessoa de contato, o meio de contato, o motivo e a data. Para os contatos com empresas que ainda são leads, use as interações de Leads de empresas.

Endpoints

Método	Caminho	Descrição
GET	/crm/interactions	Lista as interações com clientes
POST	/crm/interactions	Registra uma interação com um cliente
GET	/crm/interactions/{uuid}	Consulta uma interação
PUT	/crm/interactions/{uuid}	Altera uma interação
DELETE	/crm/interactions/{uuid}	Apaga uma interação
GET	/crm/interactions/customers	Lista os clientes (apoio)
GET	/crm/interactions/customers/{customer_vendor_uuid}/contacts	Lista os contatos de um cliente (apoio)
GET	/crm/interactions/mean-contact	Lista os meios de contato (apoio)
GET	/crm/interactions/motives	Lista os motivos de contato (apoio)
GET	/crm/interactions/proposals	Lista as propostas (apoio)

GET /crm/interactions

Lista as interações da empresa cliente, da mais recente para a mais antiga, pela data do contato.

Parâmetros de URL

Parâmetro	Descrição
customer_vendor_id	Id do cliente
customer_vendor_uuid	uuid do cliente
customer_vendor	Nome ou razão social do cliente (contém)
mean_contact_id	Id do meio de contato
mean_contact	Texto do meio de contato (contém)
motive_id	Id do motivo
motive	Texto do motivo (contém)
proposal	Código ou referência da proposta vinculada (contém)
start_date	Data inicial do contato (AAAA-MM-DD)
end_date	Data final do contato (AAAA-MM-DD)
search	Texto livre: meio de contato, nome do cliente, nome do contato, motivo e observações
per_page, page	Paginação, conforme Convenções

Exemplo

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

Resposta (200): a lista de interações, sem per_page, ou a página de interações, com per_page. Cada interação traz o nome do cliente, o contato, o meio de contato, o motivo, o código da proposta vinculada, quando houver, e os nomes de quem criou e de quem alterou.

POST /crm/interactions

Registra uma interação com um cliente.

Corpo

Campo	Obrigatório	Tipo	Descrição
customer_vendor_id	Sim	inteiro	Cliente (id do cliente)
date	Sim	data	Data do contato
contact_id	Não	inteiro	Pessoa de contato do cliente (id do contato)
mean_contact_id	Não	inteiro	Meio de contato usado
motive_id	Não	inteiro	Motivo do contato
proposal_id	Não	uuid	Proposta vinculada à interação (uuid da proposta)
observations	Não	texto	Observações sobre o contato

Exemplo

curl -X POST https://api.pedagogo.app/crm/interactions \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_vendor_id": 1,
    "date": "2026-11-11",
    "mean_contact_id": 1,
    "motive_id": 1,
    "observations": "Confirmou o interesse em nova turma."
  }'

Resposta (201): a interação registrada, com o uuid.

GET /crm/interactions/{uuid}

Consulta uma interação. Resposta (200): a interação, com os mesmos campos da listagem.

PUT /crm/interactions/{uuid}

Altera uma interação. Envie apenas os campos que mudam.

Corpo

Campo	Obrigatório	Tipo	Descrição
customer_vendor_id	Não	inteiro	Cliente
contact_id	Não	inteiro	Pessoa de contato do cliente
mean_contact_id	Não	inteiro	Meio de contato usado
motive_id	Não	inteiro	Motivo do contato
proposal_id	Não	uuid	Proposta vinculada à interação
observations	Não	texto	Observações sobre o contato

Resposta (200): a interação alterada.

DELETE /crm/interactions/{uuid}

Remove a interação. Resposta (200).

GET /crm/interactions/customers

Lista os clientes cadastrados, para escolher o cliente da interação. Resposta (200): a lista de clientes.

GET /crm/interactions/customers/{customer_vendor_uuid}/contacts

Lista os contatos de um cliente, para o campo contact_id. Resposta (200): a lista de contatos do cliente.

GET /crm/interactions/mean-contact

Lista os meios de contato, para o campo mean_contact_id. Resposta (200): a lista de meios de contato.

GET /crm/interactions/motives

Lista os motivos de contato, para o campo motive_id. Resposta (200): a lista de motivos.

GET /crm/interactions/proposals

Lista as propostas, para escolher a proposta vinculada à interação. Resposta (200): a lista de propostas, no mesmo formato de GET /crm/proposals.