Settings

Update changelog settings

Changes a site's changelog: on or off, subscriptions, reactions, email subject and categories; changelog_categories replaces the whole set. Requires a plan with the changelog.

PATCH

/sites/{site_id}/settings/changelog

cURL

curl --request PATCH \
  --url 'https://api.notiondesk.so/sites/{site_id}/settings/changelog' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "enabled": false,
  "email_subscriptions_enabled": false,
  "reactions_enabled": false,
  "email_subject_pattern": "string",
  "changelog_categories": [
    {
      "category_id": "string",
      "color": "string"
    }
  ]
}'

Authorizations

Authorizationstringheader
api_key · http · bearer
write
Authorizationstringheader
oauth · oauth2
write

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.

Body

application/jsonrequired

enabledboolean
Whether the changelog is published. Read back in Get a site as changelog_enabled.
email_subscriptions_enabledboolean
Whether readers can subscribe to changelog emails. true needs a plan with changelog email notifications.
reactions_enabledboolean
Whether readers can react to changelog entries. Read back in Get a site as changelog_reactions_enabled.
email_subject_patternstring | null
Subject line pattern of changelog emails; null and "" leave it unchanged.
changelog_categoriesobject[]
The full set of changelog categories. Read back in Get a site as changelog_categories.
- category_idstringrequired
  The id of a category of the site, from List categories, at most once in the list.
- colorstring | null

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.