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:

ChaveValor
content-typemultipart/form-data
tokene115db6fg57499fce3f726fd34af04e2

Corpo:

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

AtributoObrigatoriedadeTipoDescrição
files[]ObrigatórioArquivoArquivo local que fará o upload.
deal_idObrigatórioInteiroID da oportunidade a qual o arquivo será vinculado.
nameOpcionalStringNome ou título do arquivo.
descriptionOpcionalStringDescrição do arquivo.

Exemplo de cURL:

curl -i -X POST \
   -H "Content-Type:multipart/form-data" \
   -H "token:e115db6fg57499fce3f726fd34af04e2" \
   -F "deal_id=26385917" \
   -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": 182567309,
      "account_id": 18631,
      "user_id": 42671,
      "deal_id": 261515187,
      "email_id": null,
      "template_email_id": null,
      "call_id": null,
      "name": "FICHA CADASTRAL.pdf",
      "url": "https://api.pipe.run/v1/files/6i2vc69iehwk0swwc4gwg8g4kok0o88/download",
      "url_aws": "https://assets.pipe.run/account/94902/deals/95783813/files/lheaycr6kb6p78kkjwa0s8c8tooso8c.pdf",
      "format": "pdf",
      "description": "Arquivo para exemplo de requisição à  API",
      "size": 0,
      "hash": "6i2vc69iehwk0swwc4gwg8g4kok0o88",
      "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."
    ]
  }
}