Skip to main content
PATCH
Update customization

Authorizations

Authorization
string
header
required

API key sent as Authorization: Bearer <key>. Personal keys (gm_pat_) act as you, limited by your role and the key's scopes; organization keys (gm_api_) act for one organization. Send X-Organization-Id with every org-scoped request.

Headers

X-Organization-Id
string
required

ID of the organization to act in. Required with API keys. A user session may omit it and acts in its active organization.

Example:

"k2p9x7w4m1n8b3v6c5z0q2r7"

Path Parameters

id
string
required

Status page ID.

Body

application/json

All fields are optional; only the ones sent are changed.

primaryColor
string

CSS color, e.g. #16A34A.

accentColor
string

CSS color, e.g. #16A34A.

backgroundColor
string

CSS color, e.g. #16A34A.

foregroundColor
string

CSS color, e.g. #16A34A.

primaryForegroundColor
string

CSS color, e.g. #16A34A.

cardColor
string

CSS color, e.g. #16A34A.

cardForegroundColor
string

CSS color, e.g. #16A34A.

mutedColor
string

CSS color, e.g. #16A34A.

mutedForegroundColor
string

CSS color, e.g. #16A34A.

borderColor
string

CSS color, e.g. #16A34A.

textColor
string

CSS color, e.g. #16A34A.

useDarkTheme
boolean
showSubscriptionButton
boolean

Show the "Subscribe to updates" button.

showRecentUpdatesSection
boolean
hideHeaderName
boolean
shadowStyle
string
borderRadiusStyle
string
defaultLanguage
string

Default page language, e.g. en-US or pt-BR.

headerDisplayName
string
customCss
string

Custom CSS. Requires the Pro or Business plan.

customHeaderHtml
string

Custom header HTML. Requires the Pro or Business plan.

Custom footer HTML. Requires the Pro or Business plan.

Response

OK

id
string
required
statusPageId
string
required
primaryColor
string
required
accentColor
string
required
backgroundColor
string
required
foregroundColor
string
required
primaryForegroundColor
string
required
cardColor
string
required
cardForegroundColor
string
required
mutedColor
string
required
mutedForegroundColor
string
required
borderColor
string
required
textColor
string
required
useDarkTheme
boolean
required
shadowStyle
string
required
borderRadiusStyle
string
required
showSubscriptionButton
boolean
required
showRecentUpdatesSection
boolean
required
defaultLanguage
string | null
required
headerDisplayName
string | null
required
hideHeaderName
boolean
required
customCss
string | null
required
customHeaderHtml
string | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required