Create a status page design template

Creates a status page design template with a name and design specification, optionally copying assets from a page or another template.

POST https://app.upfour.io/v1/status-page-design-templates

A real request. Sending it changes data in your up4 account.

Authorization

AuthorizationA pls_ key. It stays in this browser tab. Needs status_page.write.

Body

namerequired At most 80 characters.

More fields4

asset_source_page_id 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. asset_source_template_id Copy the brand images (and the logo URL) from another template of the company. description At most 240 characters.

keep_assets Update only: keep the template's own images. An update without any image source removes them.

1 more field is only available in JSON.

Headers

Idempotency-KeyheaderGenerated automatically when empty. How it works

Sent directly from your browser to https://app.upfour.io/v1. Mutating calls get an automatic Idempotency-Key when the field is empty.

Request

Responsenot sent yet

Fill in a key and press Send request (⌘↵).
The answer appears here.

scope status_page.write stable Idempotency-Key supported returns 201

Body

application/json optional 6 fields

namestringrequired

At most 80 characters.

specStatusPageDesignTemplateSpecrequired

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

Field	Type	Description
`ground` optional	string one of`paperwhitecool`	Empty is stored as paper.
`header_dark` optional	string	#RRGGBB or empty for the platform default.
`header_light` optional	string	#RRGGBB or empty for the platform default.
`layout` optional	string one of`essentialbrandoverview`
`version` optional	integer	Must be 1.

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

asset_source_page_iduuid · nullable

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.

asset_source_template_iduuid · nullable

Copy the brand images (and the logo URL) from another template of the company.

descriptionstring

At most 240 characters.

keep_assetsboolean

Update only: keep the template's own images. An update without any image source removes them.

Returns

A successful request returns 201 with application/json.

Response fields 1 top-level fields

Field Type Description

data StatusPageDesignTemplate

StatusPageDesignTemplate · 32 fields

Field Type Description

accent_color string

asset_kinds string[] · nullable one oflogologo_darkfavicon The images the template stores, in the order logo, logo_dark, favicon.

assets StatusPageDesignTemplateAssetInfo[] · nullable

Each item · 4 fields

Field	Type	Description
`content_type`	string
`kind`	string one of`logologo_darkfavicon`
`sha256`	string
`size_bytes`	integer

created_at string (date-time)

description string

ground string one ofpaperwhitecool

header_dark string

header_light string

id uuid

includes_css boolean

layout string one ofessentialbrandoverview

name string

revision integer Starts at 1 and rises with every update.

spec StatusPageDesignTemplateSpecResponse

StatusPageDesignTemplateSpecResponse · 12 fields

Field Type Description

accent_color string #RRGGBB or empty for the platform default.

appearance StatusPageAppearanceResponse

StatusPageAppearanceResponse · 5 fields

Field	Type	Description
`ground`	string one of`paperwhitecool`	Empty is stored as paper.
`header_dark`	string	#RRGGBB or empty for the platform default.
`header_light`	string	#RRGGBB or empty for the platform default.
`layout`	string one of`essentialbrandoverview`
`version`	integer	Must be 1.

custom_css string At most 64 KiB; must not contain </style.

includes_css boolean Must be true for custom_css to be non-empty.

logo_url string External logo address, copied as text and never downloaded; only kept together with brand images.

theme string one ofsystemlightdark Empty is stored as system.

version integer

theme string one ofsystemlightdark

updated_at string (date-time)

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.

curl -s -X POST "https://app.upfour.io/v1/status-page-design-templates" \ -H "Authorization: Bearer $UP4_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "asset_source_page_id": "00000000-0000-4000-8000-000000000001", "description": "The look of the Acme status pages.", "name": "Acme blue", "spec": { "appearance": { "ground": "paper", "header_dark": "#7A9BFF", "header_light": "#294E9E", "layout": "brand", "version": 1 }, "version": 1 } }'

const res = await fetch("https://app.upfour.io/v1/status-page-design-templates", { method: "POST", headers: { Authorization: `Bearer ${process.env.UP4_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ asset_source_page_id: "00000000-0000-4000-8000-000000000001", description: "The look of the Acme status pages.", name: "Acme blue", spec: { appearance: { ground: "paper", header_dark: "#7A9BFF", header_light: "#294E9E", layout: "brand", version: 1, }, version: 1, }, }), }); console.log(res.status, await res.json());

import os import requests res = requests.post( "https://app.upfour.io/v1/status-page-design-templates", headers={"Authorization": f"Bearer {os.environ['UP4_API_KEY']}"}, json={ "asset_source_page_id": "00000000-0000-4000-8000-000000000001", "description": "The look of the Acme status pages.", "name": "Acme blue", "spec": { "appearance": { "ground": "paper", "header_dark": "#7A9BFF", "header_light": "#294E9E", "layout": "brand", "version": 1, }, "version": 1, }, }, ) print(res.status_code, res.json())

package main import ( "fmt" "io" "net/http" "os" "strings" ) func main() { payload := strings.NewReader(`{ "asset_source_page_id": "00000000-0000-4000-8000-000000000001", "description": "The look of the Acme status pages.", "name": "Acme blue", "spec": { "appearance": { "ground": "paper", "header_dark": "#7A9BFF", "header_light": "#294E9E", "layout": "brand", "version": 1 }, "version": 1 } }`) req, _ := http.NewRequest("POST", "https://app.upfour.io/v1/status-page-design-templates", payload) req.Header.Set("Authorization", "Bearer "+os.Getenv("UP4_API_KEY")) req.Header.Set("Content-Type", "application/json") res, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer res.Body.Close() out, _ := io.ReadAll(res.Body) fmt.Println(res.StatusCode, string(out)) }

<?php $payload = <<<'JSON' { "asset_source_page_id": "00000000-0000-4000-8000-000000000001", "description": "The look of the Acme status pages.", "name": "Acme blue", "spec": { "appearance": { "ground": "paper", "header_dark": "#7A9BFF", "header_light": "#294E9E", "layout": "brand", "version": 1 }, "version": 1 } } JSON; $ch = curl_init("https://app.upfour.io/v1/status-page-design-templates"); curl_setopt_array($ch, [ CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ "Authorization: Bearer " . getenv("UP4_API_KEY"), "Content-Type: application/json", ], CURLOPT_POSTFIELDS => $payload, ]); $response = curl_exec($ch); echo curl_getinfo($ch, CURLINFO_RESPONSE_CODE), " ", $response, "\n"; curl_close($ch);

{ "data": { "accent_color": "", "asset_kinds": [ "logo" ], "assets": [ { "content_type": "image/png", "kind": "logo", "sha256": "721378bc96ef2ddece4a66b447ba60d6a1266860d9cb23f4e0e6c152f30279cb", "size_bytes": 70 } ], "created_at": "2026-10-27T09:00:00Z", "description": "The look of the Acme status pages.", "ground": "paper", "header_dark": "#7a9bff", "header_light": "#294e9e", "id": "00000000-0000-4000-8000-000000000002", "includes_css": false, "layout": "brand", "name": "Acme blue", "revision": 1, "spec": { "accent_color": "", "appearance": { "ground": "paper", "header_dark": "#7a9bff", "header_light": "#294e9e", "layout": "brand", "version": 1 }, "custom_css": "", "includes_css": false, "logo_url": "", "theme": "system", "version": 1 }, "theme": "system", "updated_at": "2026-10-27T09:00:00Z" } }