Skip to main content
POST
Create a Sync Document

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
unique_name
string
required

Tenant-unique name for the new document.

Required string length: 1 - 256
Pattern: ^[A-Za-z0-9._:-]+$
data
object

Arbitrary JSON object payload carried by a Sync object or item. Every Sync value is a JSON map (matching Twilio Sync). The serialised payload must not exceed 64 KiB.

ttl
integer

Optional time-to-live in seconds (0 or omitted = no expiry).

Required range: 0 <= x <= 31536000

Response

The created Sync Document

data
object

A durable Sync Document — a single JSON object addressed by a unique name, carrying a monotonically increasing revision.

meta
object