Skip to main content
POST
Create a share link

Authorizations

Authorization
string
header
required

Project API key (ck_live_… or ck_test_…) presented as a bearer token. For embed partner endpoints this is the partner secret key, which is the same credential type.

Path Parameters

id
string<uuid>
required

The render id.

Body

application/json
channel
enum<string>
default:link
Available options:
link,
email
recipientEmail
string<email>

Required when channel is "email".

message
string
Maximum string length: 2000
expiresAt
string<date-time>

Response

Share created.

id
string<uuid>
required
shareToken
string
required
shareUrl
string<uri>
required
channel
enum<string>
required
Available options:
link,
email
createdAt
string<date-time>
required
recipientEmail
string<email> | null
message
string | null
expiresAt
string<date-time> | null
revokedAt
string<date-time> | null