Developers
General settings14

Update platform settings

PATCH/settings/platform

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.

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

Idempotency-Key?string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

If-Match?string

Expected revision of the resource, in the same format as the ETag header (W/"<type>:<id>:<revision>"). If the resource has changed since that revision, the request fails with 412 and the revision_mismatch error code. * matches the current revision. Any other value fails with 400 and the if_match_invalid error code. When omitted, the update is applied to the current revision.

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/settings/platform" \  -H "Content-Type: application/json" \  -d '{}'
{  "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"  }}

Retrieve platform settings GET

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.

Retrieve sharing settings GET

Returns the social sharing settings of the account: the title, description, and image used in Open Graph tags when platform links are shared. 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.