Pular para o conteúdo principal

Cursos do lead de empresa

Corresponde à aba Cursos da tela Leads de empresas. Lista os cursos que interessam à empresa, com a marca de compra.

Endpoints​

MétodoCaminhoDescrição
GET/crm/business-leads/{business_lead_uuid}/coursesLista os cursos de interesse do lead
POST/crm/business-leads/{business_lead_uuid}/coursesInclui um curso de interesse
GET/crm/business-leads/{business_lead_uuid}/courses/{id}Consulta um curso de interesse
PUT/crm/business-leads/{business_lead_uuid}/courses/{id}Altera um curso de interesse
DELETE/crm/business-leads/{business_lead_uuid}/courses/{id}Remove um curso de interesse
PATCH/crm/business-leads/{business_lead_uuid}/courses/{id}/boughtAlterna a marca de comprado

GET /crm/business-leads/{business_lead_uuid}/courses​

Lista os cursos de interesse do lead.

Parâmetros de URL

ParâmetroDescrição
searchTexto no nome do curso
per_page, pagePaginação, conforme Convenções

Resposta (200): a lista de cursos, com o nome do curso, a marca bought e os nomes de quem criou e de quem alterou.

POST /crm/business-leads/{business_lead_uuid}/courses​

Inclui um curso de interesse no lead.

Corpo

CampoObrigatórioTipoDescrição
course_idSiminteiroCurso de interesse (id do catálogo de cursos)
boughtNãobooleanoSe a empresa já comprou o curso
observationsNãotextoObservações sobre o interesse nesse curso

Exemplo

curl -X POST https://api.pedagogo.app/crm/business-leads/<uuid-do-lead>/courses \
-H "Accept: application/json" \
-H "Authorization: Bearer <token-de-sessao>" \
-H "Content-Type: application/json" \
-d '{
"course_id": 1,
"bought": false
}'

Resposta (201): o curso de interesse incluído.

PUT /crm/business-leads/{business_lead_uuid}/courses/{id}​

Altera um curso de interesse. Envie apenas os campos que mudam.

Corpo

CampoObrigatórioTipoDescrição
course_idNãointeiroCurso de interesse
boughtNãobooleanoSe a empresa já comprou o curso
observationsNãotextoObservações sobre o interesse nesse curso

Resposta (200): o curso de interesse alterado.

PATCH /crm/business-leads/{business_lead_uuid}/courses/{id}/bought​

Alterna a marca de comprado: se o curso está marcado como comprado, passa para não comprado, e o contrário. Não há corpo. Resposta (200): o curso de interesse com a marca atualizada.

Consultar e apagar​

GET /crm/business-leads/{business_lead_uuid}/courses/{id} traz o curso de interesse. DELETE /crm/business-leads/{business_lead_uuid}/courses/{id} remove o curso da lista do lead. Resposta (200).