Skip to main content
POST
Trigger a full family sync

Authorizations

X-Api-Key
string
header
required

API key for authentication. Generate one from your account settings.

Response

sync queued

id
string<uuid>
required
status
string
required
Example:

"pending"

message
string
required
Example:

"Sync has been queued and will apply all active rules"

syncable_type
string | null
syncable_id
string<uuid> | null
syncing_at
string<date-time> | null
completed_at
string<date-time> | null
window_start_date
string<date> | null
window_end_date
string<date> | null