Developers
General settings

Retrieve app settings

GET/settings/app

Returns the progressive web app (PWA) settings of the account: name, icon, theme color, Android app association, and screenshots.

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

curl -X GET "https://example.com/settings/app"
{  "data": {    "android": {      "package": "string",      "sha256_fingerprint": "string"    },    "defaults": {},    "icon": {      "file_id": "string",      "url": "string"    },    "name": "string",    "object": "settings",    "propagation": {},    "replica": {},    "revision": "string",    "screenshots": [      {        "file_id": "string",        "url": "string"      }    ],    "theme_color": "string"  }}

Update admin area settings PATCH

Updates the admin area 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. Images are referenced by the ID of a file that belongs to the account. 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 app settings PATCH

Updates the progressive web app (PWA) 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. Images are referenced by the ID of a file that belongs to the account. `android.package` and `android.sha256_fingerprint` are independent: each one changes only when it is sent, and setting `android` to `null` clears both. The Android app association is published only when both are configured. 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.