Developers
General settings

Retrieve embedded page settings

GET/settings/embedded-pages

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.

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/embedded-pages"
{  "data": {    "defaults": {},    "dynamic_content_enabled": true,    "first_access_url": "string",    "home_url": "string",    "object": "settings",    "propagation": {},    "replica": {},    "revision": "string"  }}

Update branding settings PATCH

Updates the branding 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 embedded page settings PATCH

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.