Branding

Branding allows you to easily control the look and feel of your status page with logos, icons and colour choices.

Endpoint

https://api.sorryapp.com/v1/pages/:page_id/brand

Objects

These are the attributes which represent the object, most of which can be posted too and received in response to the available methods.

Properties

Name
color_state_ok
Description
HEX or RGBa colour used on the page to indicate that things are o.k., probably green.
Name
color_state_warning
Description
HEX or RGBa colour used on the page to indicate that things are wrong, probably orange.
Name
color_navbar_background
Description
HEX or RGBa colour used on on the navbar at the top of the page.
Name
color_navbar_links
Description
HEX or RGBa colour used for the text links in the navbar.
Name
color_navbar_button_background
Description
HEX or RGBa colour used for buttons in the navbar.
Name
color_header_background
Description
HEX or RGBa colour used as the background on the page header.
Name
color_header_links
Description
HEX or RGBa colour used for links in the page header.
Name
color_header_text
Description
HEX or RGBa colour used for text in the page header.
Name
color_body_background
Description
HEX or RGBa colour used as the background on the page body.
Name
color_body_links
Description
HEX or RGBa colour used for links in the page body.
Name
color_body_text
Description
HEX or RGBa colour used for text in the page body.
Name
created_at
Description
The date/time the record was created.
Name
updated_at
Description
The date/time the record was last updated.

GET/v1/pages/:page_id/brand

Retrieve a page's branding

This endpoint displays all of the brand settings for a single page.

Request

GET

/v1/pages/12ab34cd/brand

curl -X GET https://api.sorryapp.com/v1/pages/12ab34cd/brand \
-H "Authorization: Bearer {token}"

Response

{
"response": {
    "color_state_ok": "#27ae60",
    "color_state_warning": "#e67e22",
    "color_state_info": "#2980b9",
    "color_state_alert": "#f1c40f",
    "color_navbar_background": "rgba(0,0,0,0.01)",
    "color_navbar_links": "#2c3e50",
    "color_header_background": "#F7F8F9",
    "color_header_links": "#2980b9",
    "color_header_text": "#2c3e50",
    "color_body_background": "#FFFFFF",
    "color_body_links": "#2980b9",
    "color_body_text": "#2c3e50",
    "created_at": "2025-01-21T13:37:16.929Z",
    "updated_at": "2025-01-21T13:37:16.929Z"
}
}

PATCH/v1/pages/:page_id/brand

Update a page's branding

This endpoint allows you to update the branding for a single status page, such as state colours, background etc.

Request

PATCH

/v1/pages/12ab34cd/brand

curl -X PATCH https://api.sorryapp.com/v1/pages/12ab34cd/brand \
-d color_state_ok="#059669" \
-H "Authorization: Bearer 47813b7bb2b4c6682907c8610ebd083ac1fe02bd6b3353ecead85a886e3db0b3"

Response

{
"response": {
    "color_state_ok": "#059669",
    "color_state_warning": "#e67e22",
    "color_state_info": "#2980b9",
    "color_state_alert": "#f1c40f",
    "color_navbar_background": "rgba(0,0,0,0.01)",
    "color_navbar_links": "#2c3e50",
    "color_header_background": "#F7F8F9",
    "color_header_links": "#2980b9",
    "color_header_text": "#2c3e50",
    "color_body_background": "#FFFFFF",
    "color_body_links": "#2980b9",
    "color_body_text": "#2c3e50",
    "created_at": "2025-01-21T13:37:16.929Z",
    "updated_at": "2025-01-21T14:56:26.942Z"
}
}

DELETE/v1/pages/:page_id/brand

Delete branding

This endpoint resets the status page branding back to the default settings.

Request

DELETE

/v1/pages/12ab34cd

curl -X DELETE https://api.sorryapp.com/v1/pages/12ab34cd/brand \
-H "Authorization: Bearer {token}"