Update Status Page

PATCH /api/status-pages/:id

Update Status Page

PATCH /api/status-pages/:id

Updates a status page. At least one field must be provided. Requires admin role.

Request Body (all optional)

FieldTypeDescription
customerIdnumberMove status page to another customer
namestringDisplay name (1–120 chars)
slugstringURL slug (1–120 chars, 409 on conflict)
descriptionstring|nullDescription (max 1000 chars). null clears it.
visibilitystringpublic or customer_members_only
isPublishedbooleanPublish or unpublish the page
showRecentIncidentsbooleanShow recent incidents section
showRecentMaintenancebooleanShow recent maintenance section
designConfigobjectVisual design settings (layout, colors, typography, …). See Update Status Page Design for all fields.

Example (cURL)

curl -X PATCH "$BASE_URL/api/status-pages/1" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production Status - Updated",
    "isPublished": true,
    "showRecentIncidents": true
  }'

Common errors

  • 401 Unauthorized when not authenticated
  • 403 Forbidden when not an admin
  • 404 Not found when the status page does not exist
  • 409 Conflict when slug is already taken