Change a status page's branding.
const url = 'https://api.siteqwality.com/v1/status-pages/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/branding';const options = { method: 'PATCH', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"page_title":"example","default_theme":"example","logo_s3_key":"example","logo_dark_s3_key":"example","favicon_s3_key":"example","og_image_s3_key":"example","primary_color":"example","accent_color":"example","header_text":"example","footer_text":"example","white_label":true,"meta_description":"example","custom_css":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://api.siteqwality.com/v1/status-pages/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/branding \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "page_title": "example", "default_theme": "example", "logo_s3_key": "example", "logo_dark_s3_key": "example", "favicon_s3_key": "example", "og_image_s3_key": "example", "primary_color": "example", "accent_color": "example", "header_text": "example", "footer_text": "example", "white_label": true, "meta_description": "example", "custom_css": "example" }'Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Header Parameters
Section titled “Header Parameters ”Makes a retry safe: the same key and body within 24 hours returns the first response with Idempotent-Replayed: true. The same key with another body is refused with 422 idempotency_key_reused, and one still running with 409 idempotency_key_in_use.
Request Body required
Section titled “Request Body required ”A field left out keeps its value and null clears it: default_theme goes
back to system, white_label to false, and every other field to unset.
An empty or blank text field clears it too.
object
At most 100 characters.
light, dark or system.
The s3_key an upload of type logo returned.
The s3_key an upload of type logo_dark returned: the logo the page
shows in its dark theme. Without it the page shows the logo in both.
#rrggbb. Colors the page title (without a logo) and headings.
#rrggbb. Colors the subscribe button, links, focus ring and chart
line; falls back to primary_color. The page adjusts both colors per
theme where needed to keep text and controls readable.
At most 500 characters.
At most 500 characters.
Hides the “Powered by Site Qwality” badge. true needs the White-Label pack.
At most 160 characters.
At most 50 KB.
Example generated
{ "page_title": "example", "default_theme": "example", "logo_s3_key": "example", "logo_dark_s3_key": "example", "favicon_s3_key": "example", "og_image_s3_key": "example", "primary_color": "example", "accent_color": "example", "header_text": "example", "footer_text": "example", "white_label": true, "meta_description": "example", "custom_css": "example"}Responses
Section titled “ Responses ”The branding; fields left out keep their values, null clears one
object
CDN URLs of the assets above, for previews.
Example generated
{ "status_page_id": "example", "page_title": "example", "default_theme": "example", "logo_s3_key": "example", "logo_dark_s3_key": "example", "favicon_s3_key": "example", "og_image_s3_key": "example", "logo_url": "example", "logo_dark_url": "example", "favicon_url": "example", "og_image_url": "example", "primary_color": "example", "accent_color": "example", "header_text": "example", "footer_text": "example", "white_label": true, "meta_description": "example", "custom_css": "example"}Headers
Section titled “Headers ”true when this is the stored first response
Invalid request body
An RFC 9457 problem, the body of every /v1 error.
object
https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.
urn:uuid: and the request id.
The invalid fields, when the request body was refused.
One validation failure; pointer is an RFC 6901 pointer into the request body.
object
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example", "errors": [ { "pointer": "example", "detail": "example" } ]}Missing or invalid credentials
An RFC 9457 problem, the body of every /v1 error.
object
https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.
urn:uuid: and the request id.
The invalid fields, when the request body was refused.
One validation failure; pointer is an RFC 6901 pointer into the request body.
object
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example", "errors": [ { "pointer": "example", "detail": "example" } ]}The key or member may not do this, or lacks the scope it needs
An RFC 9457 problem, the body of every /v1 error.
object
https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.
urn:uuid: and the request id.
The invalid fields, when the request body was refused.
One validation failure; pointer is an RFC 6901 pointer into the request body.
object
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example", "errors": [ { "pointer": "example", "detail": "example" } ]}No such status page in this account
An RFC 9457 problem, the body of every /v1 error.
object
https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.
urn:uuid: and the request id.
The invalid fields, when the request body was refused.
One validation failure; pointer is an RFC 6901 pointer into the request body.
object
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example", "errors": [ { "pointer": "example", "detail": "example" } ]}Too many requests; wait for the time in Retry-After
An RFC 9457 problem, the body of every /v1 error.
object
https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.
urn:uuid: and the request id.
The invalid fields, when the request body was refused.
One validation failure; pointer is an RFC 6901 pointer into the request body.
object
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example", "errors": [ { "pointer": "example", "detail": "example" } ]}