Arquivos do lead de empresa
Corresponde à aba Arquivos da tela Leads de empresas. Guarda os documentos enviados sobre o lead, como propostas assinadas, contratos em negociação ou listas de participantes.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /crm/business-leads/{business_lead_uuid}/uploads | Lista os arquivos do lead |
| POST | /crm/business-leads/{business_lead_uuid}/uploads/{id?} | Envia um arquivo para o lead; com id, substitui o arquivo do registro |
| GET | /crm/business-leads/{business_lead_uuid}/uploads/{id} | Baixa um arquivo |
| DELETE | /crm/business-leads/{business_lead_uuid}/uploads/{id} | Remove um arquivo |
GET /crm/business-leads/{business_lead_uuid}/uploads
Lista os arquivos do lead.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
| search | Texto na descrição ou no nome original do arquivo |
| per_page, page | Paginação, conforme Convenções |
Resposta (200): a lista de arquivos, com a descrição, o nome original, o tamanho, o tipo, e os nomes de quem enviou e de quem alterou.
POST /crm/business-leads/{business_lead_uuid}/uploads/{id?}
Envia um arquivo para o lead. Sem id no caminho, cria um registro novo. Com
id, substitui o arquivo do registro informado, mantendo o registro. A
requisição usa multipart/form-data, e não JSON.
Corpo (multipart/form-data)
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| file | Sim | arquivo | Arquivo a enviar. Formatos aceitos: pdf, jpg, jpeg, png, doc, docx, xls e xlsx |
| description | Não | texto | Descrição do arquivo, para identificá-lo na lista |
Exemplo
curl -X POST https://api.pedagogo.app/crm/business-leads/<uuid-do-lead>/uploads \
-H "Accept: application/json" \
-H "Authorization: Bearer <token-de-sessao>" \
-F "file=@/caminho/para/proposta-assinada.pdf" \
-F "description=Proposta assinada"
Resposta (201): o registro do arquivo enviado. Com id no caminho, o campo
file pode ser omitido quando só a descrição muda, e a resposta é o registro
atualizado.
GET /crm/business-leads/{business_lead_uuid}/uploads/{id}
Baixa o arquivo do registro. Resposta (200): o próprio arquivo, para download. Se o registro ou o arquivo não existir, a resposta é 404.
DELETE /crm/business-leads/{business_lead_uuid}/uploads/{id}
Remove o registro e o arquivo guardado. Resposta (200).