Leads da campanha

Corresponde às abas Leads da campanha e Leads de alunos da página de uma campanha, na tela Campanhas. Os leads da campanha são os leads de alunos que vão receber a mensagem.

Endpoints

Método	Caminho	Descrição
GET	/crm/campaigns/{campaign_uuid}/leads	Lista os leads da campanha
POST	/crm/campaigns/{campaign_uuid}/leads	Inclui leads de alunos na campanha
GET	/crm/campaigns/{campaign_uuid}/leads/students-leads	Lista os leads de alunos que ainda não estão na campanha
DELETE	/crm/campaigns/{campaign_uuid}/leads/{id}	Retira um lead da campanha

GET /crm/campaigns/{campaign_uuid}/leads

Lista os leads da campanha, na ordem de inclusão.

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

Resposta (200): a lista de leads da campanha. Cada item traz o id do lead na campanha, o nome do interessado, o status de envio (Pendente, Enviado ou Fracassado), o lead de aluno com a procedência e a situação, e os nomes de quem criou e de quem alterou.

POST /crm/campaigns/{campaign_uuid}/leads

Inclui leads de alunos na campanha. Leads que já estão na campanha não são duplicados.

Corpo

Campo	Obrigatório	Tipo	Descrição
campaign_uuid	Sim	uuid	uuid da campanha. Deve ser o mesmo da URL
student_lead_ids	Sim	lista de inteiros	Ids dos leads de alunos a incluir

Exemplo

curl -X POST https://api.pedagogo.app/crm/campaigns/<uuid-da-campanha>/leads \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -H "Content-Type: application/json" \
  -d '{
    "campaign_uuid": "<uuid-da-campanha>",
    "student_lead_ids": [1, 2]
  }'

Resposta (201), sem conteúdo.

GET /crm/campaigns/{campaign_uuid}/leads/students-leads

Lista os leads de alunos da empresa que ainda não estão na campanha, para incluí-los com POST /crm/campaigns/{campaign_uuid}/leads. Use esta lista para incluir leads cadastrados depois da criação da campanha.

Parâmetros de URL

Aceita os parâmetros da listagem de Leads de alunos, como search, provenance_id, situation_id, course_id, city, state, start_date, end_date, per_page e page.

Resposta (200): a lista de leads de alunos disponíveis, com o nome do interessado, a procedência, os dados de contato e a situação.

DELETE /crm/campaigns/{campaign_uuid}/leads/{id}

Retira um lead da campanha. O id é o da linha do lead na campanha, retornado pela listagem. Resposta (200).