Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-133378162.5 KB
Upload Sessions

Start Upload Session

Start an Upload Session. Upload sessions are used to upload large files, use the Upload File endpoint to upload smaller files (up to 100MB). Note that the base URL is upload.apideck.com instead of unify.apideck.com. For more information on uploads, refer to the file upload guide.

post/file-storage/upload-sessions

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Request body

namestring required

The name of the file.

parent_folder_idstring required

The parent folder to create the new file within. This can be an ID or a path depending on the downstream folder. Please see the connector section below to see downstream specific gotchas.

drive_idstring

ID of the drive to upload to.

sizeinteger nullable required

The size of the file in bytes

Example request

{
  "name": "Documents",
  "parent_folder_id": "1234",
  "drive_id": "1234",
  "size": 1810673,
  "pass_through": [
    {
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response

UploadSessions

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "service": "dropbox",
  "resource": "UploadSessions",
  "operation": "one",
  "data": {
    "id": "12345"
  }
}