Developers
General settings

Update embedded page settings

PATCH/settings/embedded-pages

Updates the embedded page 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.

home_url and first_access_url must use the HTTP or HTTPS scheme.

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

If-Match?string

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

curl -X PATCH "https://example.com/settings/embedded-pages" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "defaults": {},    "dynamic_content_enabled": true,    "first_access_url": "string",    "home_url": "string",    "object": "settings",    "propagation": {},    "replica": {},    "revision": "string"  }}

Retrieve embedded page settings GET

Returns the settings for pages embedded in the student area: the home page URL, the first-access page URL, and whether dynamic content is enabled. 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.

Retrieve gamification settings GET

Returns the gamification settings of the account: ranking visibility, the scoring rule for comments, and the triggers that award points. Requires the `gamification.read` permission; `settings.read` does not grant access to this group. 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.