Skip to main content
POST
Register files for upload

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.

Path Parameters

id
string
required

Collection id. Never a slug — see the Concepts page.

Body

application/json
files
object[]

Files you will upload yourself.

Maximum array length: 500
imports
object[]

Files Yungle fetches from URLs itself, so the bytes never pass through you. Up to 20 per call. Each is created like an upload (quota, size ceilings, API metering) and imported in the background; follow it with GET /imports/{fileId}.

Maximum array length: 20
folderId
string | null

Target folder. Omit or null for the collection root.

Required string length: 1 - 64

Response

Upload targets.

tusEndpoint
string<uri>
required

Stream each file here with tus.

files
object[]
required

One per entry in files, in the same order.

imports
object[]
required

One per entry in imports, in the same order. Empty when none were sent.