Cursos do lead de aluno
Corresponde à aba Cursos da tela Leads de alunos. Guarda os cursos de interesse do lead. As campanhas usam esses cursos para escolher os leads que vão receber a mensagem.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /crm/students-leads/{student_lead_uuid}/courses | Lista os cursos de interesse do lead |
| POST | /crm/students-leads/{student_lead_uuid}/courses | Inclui um curso de interesse |
| GET | /crm/students-leads/{student_lead_uuid}/courses/{id} | Consulta um curso de interesse |
| PUT | /crm/students-leads/{student_lead_uuid}/courses/{id} | Altera um curso de interesse |
| DELETE | /crm/students-leads/{student_lead_uuid}/courses/{id} | Remove um curso de interesse |
GET /crm/students-leads/{student_lead_uuid}/courses
Lista os cursos de interesse do lead, pelo uuid do lead no caminho.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
| course_id | Id do curso |
| search | Texto livre: nome do curso ou nome do aluno vinculado |
| per_page, page | Paginação, conforme Convenções |
Resposta (200): a lista de cursos, com o nome do curso, o aluno vinculado, quando houver, o e-mail e o celular do lead, e os nomes de quem criou e de quem alterou.
POST /crm/students-leads/{student_lead_uuid}/courses
Inclui um curso de interesse no lead.
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| course_id | Sim | inteiro | Curso de interesse (id do catálogo de cursos) |
| training_student_id | Não | inteiro | Id do aluno matriculado ligado a este interesse |
| observations | Não | texto | Observações sobre o interesse nesse curso |
Exemplo
curl -X POST https://api.pedagogo.app/crm/students-leads/<uuid-do-lead>/courses \
-H "Accept: application/json" \
-H "Authorization: Bearer <token-de-sessao>" \
-H "Content-Type: application/json" \
-d '{
"course_id": 1,
"observations": "Quer começar no próximo semestre."
}'
Resposta (201): o curso de interesse incluído.
PUT /crm/students-leads/{student_lead_uuid}/courses/{id}
Altera um curso de interesse. Envie apenas os campos que mudam.
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| course_id | Não | inteiro | Curso de interesse |
| training_student_id | Não | inteiro | Id do aluno matriculado ligado a este interesse |
| observations | Não | texto | Observações sobre o interesse nesse curso |
Resposta (200): o curso de interesse alterado.
Consultar e apagar
GET /crm/students-leads/{student_lead_uuid}/courses/{id} traz o curso de
interesse. DELETE /crm/students-leads/{student_lead_uuid}/courses/{id} remove
o curso da lista do lead. Resposta (200).