Sync

Trigger a site sync

Queues a sync of the whole site from its source. Answers 409 while another sync of the site is queued or running. With automatic translation on, changed content is translated and billed.

POST
/sites/{site_id}/sync
cURL
curl --request POST \
  --url 'https://api.notiondesk.so/sites/{site_id}/sync' \
  --header 'Authorization: Bearer <token>'

Authorizations

  • Authorizationstringheader

    api_key · http · bearer

    sync
  • Authorizationstringheader

    oauth · oauth2

    sync

Path parameters

  • site_idstringrequired

    The id of a site from List sites.

Headers

  • nd-versionstring

    The contract version your integration was written against. Without it, the request uses the current version. An unknown value answers 400 invalid_version.

  • Idempotency-Keystring

    Makes a write safe to retry: the same key and body replay the first response with X-Idempotent-Replay: true. A different body answers 422 idempotency_key_reused; keys last at least 24 hours.

Responses

Done. The body is empty. A replay with the same Idempotency-Key also answers 204 with an empty body.

Headers

  • nd-versionstring

    The contract version that answered the request.

  • X-Idempotent-Replaystring

    true when the response replays an earlier request sent with the same Idempotency-Key, otherwise false.

  • X-RateLimit-Limitinteger

    Requests allowed per minute: 120 for GET, 20 for writes, per key or OAuth grant.

  • X-RateLimit-Remaininginteger

    Requests left in the current window.

  • Retry-Afterinteger

    Seconds until the next request is accepted; 0 while requests remain.