Skip to main content
POST
Create an upload request

Authorizations

Authorization
string
header
required

An API key from Settings → API keys, sent as Authorization: Bearer yk_live_…. Scopes: transfers:read, transfers:write, collections:read, collections:write, contacts:read, contacts:write, webhooks:read, webhooks:write. A write scope implies read of the same resource.

Body

application/json
collectionId
string
required

Where the files land. Not the vault.

Required string length: 1 - 64
title
string
required

Shown to the people uploading.

Required string length: 1 - 200
message
string

A note on the upload page.

Maximum string length: 2000
password
string

Uploaders must enter this first.

Required string length: 1 - 256
requiredItems
string[]

A checklist shown on the page — guidance, not enforcement.

Maximum array length: 30
Required string length: 1 - 200
expiresAt
string<date-time>

When the link stops taking uploads. Omit for never.

Response

The request, with the link to give people.

request
object
required

A public upload link that files arrive through, into one of your collections.