Trigger sync

Triggers a full sync for the user’s family, including all connected accounts and active rules.

POST /api/v1/sync

Trigger sync

cURL

curl --request POST \
  --url https://app.sure.am/api/v1/sync \
  --header 'X-Api-Key: <api-key>'

202

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "message": "<string>",
  "syncable_type": "<string>",
  "syncable_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "syncing_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "window_start_date": "2023-12-25",
  "window_end_date": "2023-12-25"
}

Authorizations

X-Api-Key · string · header · required

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

Response

202 - application/json

sync queued

id · string<uuid> · required

status · string · required

message · string · required

syncable_type · string

syncable_id · string<uuid>

syncing_at · string<date-time> | null

completed_at · string<date-time> | null

window_start_date · string<date> | null

window_end_date · string<date> | null