Update branding settings
/settings/brandingUpdates 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.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Header Parameters
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/branding" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "accent_color": "string", "certificate_logo": { "dark": { "file_id": "string", "url": "string" }, "light": { "file_id": "string", "url": "string" } }, "defaults": {}, "favicon": { "file_id": "string", "url": "string" }, "logo": { "file_id": "string", "url": "string" }, "object": "settings", "propagation": {}, "replica": {}, "revision": "string" }}Retrieve branding settings GET
Returns the branding settings of the account: accent color, logo, favicon, and certificate logos. 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 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.