Contatos da proposta

Corresponde à seção Contatos da página da proposta, na tela Propostas. São as pessoas do cliente que recebem a proposta.

Endpoints

Método	Caminho	Descrição
GET	/crm/proposals/{proposal_uuid}/contacts	Lista os contatos da proposta
POST	/crm/proposals/{proposal_uuid}/contacts	Inclui um contato na proposta
GET	/crm/proposals/{proposal_uuid}/contacts/{uuid}	Consulta um contato da proposta
PUT	/crm/proposals/{proposal_uuid}/contacts/{uuid}	Altera um contato da proposta
DELETE	/crm/proposals/{proposal_uuid}/contacts/{uuid}	Remove um contato da proposta
GET	/crm/proposals/contacts/customers	Lista os contatos dos clientes (apoio)
GET	/crm/proposals/contacts/proposals	Lista as propostas (apoio)

GET /crm/proposals/{proposal_uuid}/contacts

Lista os contatos da proposta.

Parâmetros de URL

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

Resposta (200): a lista de contatos da proposta, com o nome do contato e os nomes de quem criou e de quem alterou.

POST /crm/proposals/{proposal_uuid}/contacts

Inclui um contato na proposta.

Corpo

Campo	Obrigatório	Tipo	Descrição
contact_id	Sim	inteiro	Pessoa de contato do cliente (id do contato)

Exemplo

curl -X POST https://api.pedagogo.app/crm/proposals/<uuid-da-proposta>/contacts \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -H "Content-Type: application/json" \
  -d '{
    "contact_id": 1
  }'

Resposta (201): o contato incluído na proposta, com o uuid.

PUT /crm/proposals/{proposal_uuid}/contacts/{uuid}

Altera o contato da proposta.

Corpo

Campo	Obrigatório	Tipo	Descrição
contact_id	Não	inteiro	Pessoa de contato do cliente

Resposta (200): o contato alterado.

Consultar e apagar

GET /crm/proposals/{proposal_uuid}/contacts/{uuid} traz o contato da proposta. DELETE /crm/proposals/{proposal_uuid}/contacts/{uuid} remove o contato da proposta. Resposta (200).

GET /crm/proposals/contacts/customers

Lista os contatos dos clientes, para o campo contact_id. Resposta (200): a lista de contatos.

GET /crm/proposals/contacts/proposals

Lista as propostas, no mesmo formato de GET /crm/proposals. Resposta (200): a lista de propostas.