Adicionar arquivo

Endpoint utilizado para realizar upload de um arquivo em uma oportunidade na conta do CRM PipeRun.

URL: https://api.pipe.run/v1/files/upload

Cabeçalho:

Atributos necessários no cabeçalho da requisição:

Chave	Valor
content-type	multipart/form-data
token	TOKEN DA API

Corpo:

Atributos contidos na requisição de upload de arquivos na oportunidade. Atenção nos campos obrigatórios.

pelo menos um dos campos deal_id, company_id ou person_id deve ser preenchido contendo o ID da entidade ao qual o arquivo será adicionado.

Atributo	Obrigatoriedade	Tipo	Descrição
files[]	Obrigatório	Arquivo	Arquivo local que fará o upload.
deal_id	Opcional	Inteiro	ID da oportunidade a qual o arquivo será vinculado.
person_id	Opcional	Inteiro	ID da pessoal a qual o arquivo será vinculado.
company_id	Opcional	Inteiro	ID da empresa a qual o arquivo será vinculado.
name	Opcional	String	Nome ou título do arquivo.
description	Opcional	String	Descrição do arquivo.

Exemplo de cURL:

curl -i -X POST \
   -H "Content-Type:multipart/form-data" \
   -H "token:TOKEN_API" \
   -F "deal_id=123" \
   -F "files[]=@\"./FICHA CADASTRAL.pdf\";type=application/pdf;filename=\"FICHA CADASTRAL.pdf\"" \
 'https://api.pipe.run/v1/files/upload'

Exemplo de respostas:

201 - Created:

{
  "success": true,
  "message": "OK",
  "data": [
    {
      "id": 123,
      "account_id": 123,
      "user_id": 123,
      "deal_id": 123,
      "email_id": null,
      "template_email_id": null,
      "call_id": null,
      "name": "NOME DO ARQUIVO.pdf",
      "url": "https://api.pipe.run/v1/files/...download",
      "url_aws": "https://assets.pipe.run/account/.../lheaycr6kb6p78kkjwa0s8c8tooso8c.pdf",
      "format": "pdf",
      "description": "Arquivo para exemplo de requisição à  API",
      "size": 0,
      "hash": "6i2vc69i...8g4kok0o88",
      "created_at": "2023-05-29 15:00:13",
      "public_form_file": null
    }
  ]
}

404 - Not found:

{
  "success": false,
  "message": "Not Found"
}

422 - Unprocessable entity:

{
  "success": false,
  "message": "Unprocessable Content",
  "data": {
    "files": [
      "O campo files é obrigatório."
    ]
  }
}