Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-133378162.5 KB
Shared Links

Create Shared Link

Create Shared Link

post/file-storage/shared-links

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

urlstring nullable

The URL that can be used to view the file.

download_urlstring nullable

The URL that can be used to download the file.

target_idstring nullable required

The ID of the file or folder to link.

scope'public' | 'company' nullable

The scope of the shared link.

password_protectedboolean nullable

Indicated if the shared link is password protected.

passwordstring nullable

Optional password for the shared link.

expires_atstring date-time nullable
updated_atstring date-time nullable

The date and time when the object was last updated.

created_atstring date-time nullable

The date and time when the object was created.

Example request

{
  "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
  "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
  "target": {
    "id": "12345",
    "name": "sample.jpg",
    "type": "file"
  },
  "scope": "company",
  "expires_at": "2022-09-30T07:43:32.000Z",
  "updated_at": "2020-09-30T07:43:32.000Z",
  "created_at": "2020-09-30T07:43:32.000Z",
  "pass_through": [
    {
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response

Shared Links

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": "Shared Links",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}