Pular para o conteúdo principal

Tarefas do lead de empresa

Corresponde à aba Tarefas da tela Leads de empresas. Lista as atividades ligadas ao lead, como retornar uma ligação ou enviar uma proposta. Cada tarefa é a mesma tarefa da tela Tarefas, vinculada ao lead; veja Tarefas.

Endpoints​

MétodoCaminhoDescrição
GET/crm/business-leads/{business_lead_uuid}/tasksLista as tarefas do lead
POST/crm/business-leads/{business_lead_uuid}/tasksCria uma tarefa para o lead
GET/crm/business-leads/{business_lead_uuid}/tasks/{id}Consulta uma tarefa do lead
PUT/crm/business-leads/{business_lead_uuid}/tasks/{id}Altera uma tarefa do lead
DELETE/crm/business-leads/{business_lead_uuid}/tasks/{id}Remove uma tarefa do lead
PATCH/crm/business-leads/{business_lead_uuid}/tasks/{id}/completeMarca a tarefa como concluída
GET/crm/business-leads/tasks/statusesLista as situações de tarefa (apoio)
GET/crm/business-leads/tasks/prioritiesLista as prioridades de tarefa (apoio)

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

Lista as tarefas do lead.

Parâmetros de URL

ParâmetroDescrição
searchTexto no assunto ou na descrição da tarefa
business_lead_idId do lead
status_idId da situação da tarefa
priority_idId da prioridade da tarefa
start_dateData inicial do vencimento da tarefa (AAAA-MM-DD)
end_dateData final do vencimento da tarefa (AAAA-MM-DD)
per_page, pagePaginação, conforme Convenções

Resposta (200): a lista de tarefas, com o assunto, o vencimento, o lembrete, a situação, a prioridade e os nomes de quem criou e de quem alterou.

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

Cria uma tarefa para o lead. Há duas formas:

  • Nova tarefa: informe subject e os demais campos.
  • Tarefa existente: informe task_uuid com o uuid de uma tarefa já cadastrada, para vinculá-la ao lead.

Corpo

CampoObrigatórioTipoDescrição
task_uuidNãouuidTarefa já cadastrada, a vincular ao lead
subjectSim, se task_uuid não for informadotextoAssunto da tarefa
priority_idNãointeiroPrioridade da tarefa
status_idNãointeiroSituação da tarefa
user_idNãointeiroResponsável pela tarefa. Sem ele, a tarefa fica com o usuário que a criou
due_dateNãodataData de vencimento
reminder_datetimeNãodata e horaLembrete. Não pode ser posterior à data de vencimento
descriptionNãotextoDescrição da tarefa

Exemplo

curl -X POST https://api.pedagogo.app/crm/business-leads/<uuid-do-lead>/tasks \
-H "Accept: application/json" \
-H "Authorization: Bearer <token-de-sessao>" \
-H "Content-Type: application/json" \
-d '{
"subject": "Enviar proposta",
"due_date": "2026-11-20",
"reminder_datetime": "2026-11-19 09:00:00"
}'

Resposta (201): o vínculo da tarefa com o lead.

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

Altera a tarefa e o vínculo com o lead. Envie apenas os campos que mudam.

Corpo

CampoObrigatórioTipoDescrição
subjectNãotextoAssunto da tarefa
priority_idNãointeiroPrioridade da tarefa
status_idNãointeiroSituação da tarefa
user_idNãointeiroResponsável pela tarefa
due_dateNãodataData de vencimento
reminder_datetimeNãodata e horaLembrete. Não pode ser posterior à data de vencimento
descriptionNãotextoDescrição da tarefa

Resposta (200): o vínculo da tarefa com o lead, já com os dados atualizados.

Consultar e apagar​

GET /crm/business-leads/{business_lead_uuid}/tasks/{id} traz o vínculo, com a tarefa e o lead. DELETE /crm/business-leads/{business_lead_uuid}/tasks/{id} remove o vínculo e a tarefa. Resposta (200).

PATCH /crm/business-leads/{business_lead_uuid}/tasks/{id}/complete​

Marca a tarefa como concluída. Não há corpo. Resposta (200): a tarefa, com a situação Concluída.

GET /crm/business-leads/tasks/statuses​

Lista as situações de tarefa, para os campos status_id. Aceita per_page e page. Resposta (200): a lista de situações.

GET /crm/business-leads/tasks/priorities​

Lista as prioridades de tarefa, para o campo priority_id. Aceita per_page e page. Resposta (200): a lista de prioridades.