Developers
General settings

Retrieve sharing settings

GET/settings/sharing

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. 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

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/settings/sharing"
{  "data": {    "defaults": {},    "description": "string",    "image": {      "file_id": "string",      "url": "string"    },    "object": "settings",    "propagation": {},    "replica": {},    "revision": "string",    "title": "string"  }}

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.

Update sharing settings PATCH

Updates the social sharing 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. The image is 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.