Contatos do lead de empresa

Corresponde à aba Contatos da tela Leads de empresas. São as pessoas que representam a empresa do lead. Os contatos são usados nas interações e são copiados para o cliente quando o lead é convertido.

Endpoints

Método	Caminho	Descrição
GET	/crm/business-leads/{business_lead_uuid}/contacts	Lista os contatos do lead
POST	/crm/business-leads/{business_lead_uuid}/contacts	Cadastra um contato
GET	/crm/business-leads/{business_lead_uuid}/contacts/{id}	Consulta um contato
PUT	/crm/business-leads/{business_lead_uuid}/contacts/{id}	Altera um contato
DELETE	/crm/business-leads/{business_lead_uuid}/contacts/{id}	Apaga um contato

GET /crm/business-leads/{business_lead_uuid}/contacts

Lista os contatos do lead.

Parâmetros de URL

Parâmetro	Descrição
search	Texto no nome do contato
per_page, page	Paginação, conforme Convenções

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

POST /crm/business-leads/{business_lead_uuid}/contacts

Cadastra um contato no lead.

Corpo

Campo	Obrigatório	Tipo	Descrição
name	Sim	texto	Nome da pessoa de contato
email	Não	texto	E-mail da pessoa
phonenumber	Não	texto	Telefone
cellphone	Não	texto	Celular
observation	Não	texto	Observação sobre o contato

Exemplo

curl -X POST https://api.pedagogo.app/crm/business-leads/<uuid-do-lead>/contacts \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Contato exemplo",
    "email": "[email protected]"
  }'

Resposta (201): o contato cadastrado.

PUT /crm/business-leads/{business_lead_uuid}/contacts/{id}

Altera um contato. Envie apenas os campos que mudam. Aceita os mesmos campos do cadastro, todos opcionais.

Resposta (200): o contato alterado.

Consultar e apagar

GET /crm/business-leads/{business_lead_uuid}/contacts/{id} traz o contato. DELETE /crm/business-leads/{business_lead_uuid}/contacts/{id} remove o contato do lead. Resposta (200).