Pular para o conteúdo principal

Contatos do lead de aluno

Corresponde à aba Contatos da tela Leads de alunos. O registro guarda o histórico de ligações, mensagens e outros contatos com o lead. As mensagens enviadas por uma campanha também aparecem aqui, como anotação com o nome da campanha e o canal usado.

Endpoints​

MétodoCaminhoDescrição
GET/crm/students-leads/{student_lead_uuid}/contactsLista os contatos do lead
POST/crm/students-leads/{student_lead_uuid}/contactsRegistra um contato
GET/crm/students-leads/{student_lead_uuid}/contacts/{id}Consulta um contato
PUT/crm/students-leads/{student_lead_uuid}/contacts/{id}Altera um contato
DELETE/crm/students-leads/{student_lead_uuid}/contacts/{id}Apaga um contato

GET /crm/students-leads/{student_lead_uuid}/contacts​

Lista os contatos do lead, pelo uuid do lead no caminho.

Parâmetros de URL: per_page e page, conforme Convenções.

Resposta (200): a lista de contatos, com a data, os comentários e os nomes de quem criou e de quem alterou.

POST /crm/students-leads/{student_lead_uuid}/contacts​

Registra um contato com o lead.

Corpo

CampoObrigatórioTipoDescrição
dateSimdataData do contato
commentsSimtextoDescrição do contato

Exemplo

curl -X POST https://api.pedagogo.app/crm/students-leads/<uuid-do-lead>/contacts \
-H "Accept: application/json" \
-H "Authorization: Bearer <token-de-sessao>" \
-H "Content-Type: application/json" \
-d '{
"date": "2026-11-11",
"comments": "Retornou a ligação e pediu a grade do curso."
}'

Resposta (201): o contato registrado.

PUT /crm/students-leads/{student_lead_uuid}/contacts/{id}​

Altera um contato. Envie apenas os campos que mudam.

Corpo

CampoObrigatórioTipoDescrição
dateNãodataData do contato
commentsNãotextoDescrição do contato

Resposta (200): o contato alterado.

Consultar e apagar​

GET /crm/students-leads/{student_lead_uuid}/contacts/{id} traz o contato. DELETE /crm/students-leads/{student_lead_uuid}/contacts/{id} remove o contato do histórico. Resposta (200).