Skip to main content
POST
Create vault upload session

Authorizations

Authorization
string
header
required

Link access token for one Sandbox, Test, or Live authorization.

x-linked-account-id
string
header
required

Selects one of the authorization's linked accounts via the x-linked-account-id header.

Headers

x-linked-account-id
string
required

The linked account to use. The user must have shared it with your app. A missing account returns linked_account_required; an account outside your access returns linked_account_not_granted.

Example:

"conn_example123"

Body

application/json
files
object[]
required

Files to upload together through one scheduled vault message after all files finalize

Required array length: 1 - 10 elements
vaultUpload
object
required

Options for creating Vault media from the batch

Response

Successful response

batchId
string
required
status
enum<string>
required
Available options:
pending,
completed
totalFiles
integer
required
Required range: x > 0
expiresAt
string
required
uploads
object[]
required
mediaIds
number[]
media
object[]