Update a status page design template
Updates a status page design template with an expected revision and design specification.
Parameters
| Field | Type | Description |
|---|---|---|
templateID required | uuid | path parameter |
Body
The revision the caller last read. A template that changed since answers 409 with code design_template_conflict.
At most 80 characters.
The look of a page, at most 80 KiB. Unknown keys are refused; version must be 1 and appearance is required.
Nested fields 12 fields
| Field | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
accent_color optional | string | #RRGGBB or empty for the platform default. | ||||||||||||||||||
appearance optional | StatusPageAppearance | |||||||||||||||||||
StatusPageAppearance · 5 fields
| ||||||||||||||||||||
custom_css optional | string | At most 64 KiB; must not contain </style. | ||||||||||||||||||
includes_css optional | boolean | Must be true for custom_css to be non-empty. | ||||||||||||||||||
logo_url optional | string | External logo address, copied as text and never downloaded; only kept together with brand images. | ||||||||||||||||||
theme optional | string one ofsystemlightdark | Empty is stored as system. | ||||||||||||||||||
version optional | integer | |||||||||||||||||||
All other fields4 fields
Copy the brand images (and the logo URL) from this status page. At most one of asset_source_page_id, asset_source_template_id and keep_assets.
Copy the brand images (and the logo URL) from another template of the company.
At most 240 characters.
Update only: keep the template's own images. An update without any image source removes them.
Returns
A successful request returns 200 with application/json.
Response fields 1 top-level fields
| Field | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data | StatusPageDesignTemplate | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
StatusPageDesignTemplate · 32 fields
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Errors
Only the errors this operation can return. Every error uses the same envelope.
| Status | Code | Meaning |
|---|---|---|
| 400 | bad_request | The request is malformed or fails validation. |
| 409 | design_template_conflict | The design template was changed after the caller read it. When: Updating or applying a design template that was changed after the caller read it. Fix: Reload the template and apply the change again. |
| 404 | design_template_not_found | The design template does not exist or is not visible to the caller. When: A design template id in the path or body that is unknown or not visible to the caller. Fix: List design templates and use an id from the list. |
| 404 | not_found | The requested resource does not exist or is outside the caller's scope. |
| 403 | permission_denied | The credentials do not permit this action. |
| 200 / 410 / 413 / 422 | request_failed | The request could not be completed. |
Every call can also return unauthorized (401), rate_limit_exceeded (429) or internal_error (500 / 502). See Responses and errors.