Skip to main content
POST
Send it

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

Transfer id. Never the share slug, which is a capability.

Body

application/json
recipients
string<email>[]

Omit to get a link only. Each address here is emailed on your behalf.

Maximum array length: 10
message
string
Maximum string length: 2000
password
string

Recipients must enter this to open the transfer.

Required string length: 1 - 256
title
string
Maximum string length: 200
e2eeMeta
string

End-to-end encrypted transfers only: the sealed { message }, bound to the transfer’s slug.

Maximum string length: 8192

Response

The finalized transfer, and who was notified.

transfer
object
required
notified
string[]
required

Who was emailed. Empty for a link-only send.