Skip to main content
POST
Create status update

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

statusPageId
string
required

Status page ID.

Body

application/json
title
string
required
Example:

"Elevated API errors"

body
string
required

Update text.

Example:

"We are investigating."

state
enum<string>
required

draft is only visible to members; published appears on the page.

Available options:
draft,
published
updateType
enum<string>
required
Available options:
incident,
maintenance,
informational
impact
enum<string>
required
Available options:
none,
minor,
major,
critical
components
object[]

Affected components and their status.

Response

Created

id
string
required
statusPageId
string
required
responseIncidentId
string | null
required
title
string
required
body
string
required
state
string
required
updateType
string
required
impact
string
required
publishedAt
string | null
required
createdByUserId
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required