Skip to main content
PATCH
Pause, resume or close 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.

Path Parameters

id
string
required

Upload request id.

Body

application/json
status
enum<string>
required

paused stops uploads until set back to active; closed stops them for good, and a closed request cannot be set back.

Available options:
active,
paused,
closed

Response

The updated request.

request
object
required

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