Skip to main content

Upload File

POST /v1/integration/:id/file

Creates a new file upload for an integration. Validates the received file, stores it, and returns identifiers plus convenience links for listing rows, previewing values, importing, and deleting the uploaded file.

Request Body​

file: @file(/Users/Products/4_pro.csv)

Response Example​

{
  "status": true,
  "message": "File uploaded. Follow links below to work with this file.",
  "data": {
    "filename": "example.csv",
    "uuid": "tenant-id-1-upload-id-1"
  },
  "links": {
    "list": {
      "method": "GET",
      "href": "https://api.example.com/v1/integration/integration-id-1/file/rows?filename=example.csv&limit=1&skip=0&csvOptions[fieldDelimiter]=,"
    },
    "values": {
      "method": "GET",
      "href": "https://api.example.com/v1/integration/integration-id-1/file/values?filename=example.csv&ids=1,2,3&all=false&csvOptions[fieldDelimiter]=,&csvOptions[valueDelimiter]=,"
    },
    "import": {
      "method": "POST",
      "href": "https://api.example.com/v1/integration/integration-id-1/file/values?filename=example.csv"
    },
    "delete": {
      "method": "DELETE",
      "href": "https://api.example.com/v1/integration/integration-id-1/file?filename=example.csv"
    }
  }
}