Update Status Page Text

POST /api/im/incidents/:id/statuspage-update

Sets the curated text that status pages show for this incident (statuspageUpdate on the incident). Status pages that a status page rule currently switched because of this incident show the new text immediately. If the text actually changed, subscribers of those pages are notified with an incident update. Whether a rule applies to the incident at all is reported as statuspageRuleApplies by Get Incident; without such a rule the text is stored but appears nowhere. The change is written to the IM audit log.

AuthenticationCopy Anchor Link

Requires IM access, see Authentication, and status page write access: role admin or editor. A responder cannot use this endpoint. An organization-wide API token passes as an organization admin. Incident Management must be enabled for the organization. There is no team restriction.

Request BodyCopy Anchor Link

Example (cURL)Copy Anchor Link

curl -X POST "$BASE_URL/api/im/incidents/42/statuspage-update" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "update": "We are investigating slow logins. Next update in 30 minutes." }'

ResponseCopy Anchor Link

200 OK: the text as stored.

{
  "ok": true,
  "statuspageUpdate": "We are investigating slow logins. Next update in 30 minutes."
}

Common errorsCopy Anchor Link

• 401 Unauthorized when not authenticated
• 403 Forbidden (customerScopedTokenForbidden) when using a customer-scoped token
• 403 Forbidden (imAccessDenied) when the session user has no IM-eligible role
• 403 Forbidden (imNotEnabled) when Incident Management is not enabled for the organization
• 403 Forbidden (no data.code) when your role is neither admin nor editor
• 400 Bad Request (invalidRequestBody) when :id is not a positive integer, or update is missing or neither a string nor null
• 404 Not Found (imIncidentNotFound) when the incident does not exist, or belongs to another organization