Skip to main content
POST
/
v1
/
renders
/
{id}
/
shares
Create a share link
curl --request POST \
  --url https://api.craftkit.dev/v1/renders/{id}/shares \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel": "link",
  "expiresAt": "2026-07-01T00:00:00.000Z"
}
'
{
  "id": "9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
  "shareToken": "shr_abc123",
  "shareUrl": "https://api.craftkit.dev/share/shr_abc123",
  "channel": "link",
  "recipientEmail": null,
  "message": null,
  "expiresAt": "2026-07-01T00:00:00.000Z",
  "revokedAt": null,
  "createdAt": "2026-06-21T10:00:00.000Z"
}

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