Developers
General settings14

Retrieve platform settings

GET/settings/platform

Returns the platform settings of the account, such as language, title, showcase layout, dark mode, font size, sidebar visibility, and footer options.

The defaults object contains the default values, which lets you distinguish configured values from defaults. The revision field identifies the current revision of the settings.

The response includes an ETag representing the current revision of these settings; changes to other settings groups do not affect it. Send this value in the If-Match header when updating these settings to avoid overwriting a newer version.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/settings/platform"
{  "data": {    "dark_mode": true,    "defaults": {},    "font_size": "padrao",    "footer": {      "disclaimer": "string",      "hide_privacy": true,      "hide_support": true,      "hide_terms": true    },    "language": "string",    "object": "settings",    "propagation": {      "area": "immediate",      "cached_assets": "next_build"    },    "replica": {      "is_child": true,      "note": "string"    },    "revision": "string",    "showcase_layout": "default",    "sidebar_hidden": true,    "title": "string"  }}

Update gamification settings PATCH

Updates the gamification settings. Only the fields included in the request are changed, and triggers omitted from `triggers` are left unchanged. A trigger's `points` value must be at least 1. To stop a trigger from awarding points, set its `enabled` field to `false`. Requires the `gamification.update` permission. To avoid overwriting a newer version, send the `ETag` returned by the retrieve operation in the `If-Match` header. The header is optional; when it is omitted, the update is applied to the current revision.

Update platform settings PATCH

Updates the platform settings. Only the fields included in the request are changed: setting a field to `null` clears its configured value and restores the default, and omitted fields are left unchanged. To avoid overwriting a newer version, send the `ETag` returned by the retrieve operation in the `If-Match` header. The header is optional; when it is omitted, the update is applied to the current revision.