Status Page Announcements

Create, list, update and delete announcements shown on a status page

Overview

Announcements are general notices on a status page, such as planned changes or news, that are not tied to an outage. For outage communication use status page incidents.

Action	Endpoint
List	GET /api/projects/{projectId}/status-pages/{statusPageId}/announcements
Create	POST /api/projects/{projectId}/status-pages/{statusPageId}/announcements
Get	GET /api/projects/{projectId}/status-pages/{statusPageId}/announcements/{id}
Update	PATCH /api/projects/{projectId}/status-pages/{statusPageId}/announcements/{id}
Delete	DELETE /api/projects/{projectId}/status-pages/{statusPageId}/announcements/{id}

Authentication

Header	Required	Description
X-API-Key	Yes	Your API key (Authorization: Bearer {jwt} also works). Write requests need the read_write scope.
Content-Type	Yes (when sending a body)	application/json

Required access: project viewer or higher to read; project admin to create, update and delete. No X-Project-ID header is needed.

Path parameters

Parameter	Type	Description
projectId	UUID	The project
statusPageId	UUID	The status page
id	UUID	The announcement (get, update, delete)

The announcement object

Field	Type	Description
id	UUID	Announcement ID
status_page_id	UUID	The status page
title	string	1-200 characters
message	string	1-5000 characters
type	string	info, warning, promotion or update
is_published	boolean	Whether the announcement is visible on the page
published_at, created_at, updated_at	string	ISO 8601 timestamps

List announcements

Returns all announcements, most recently published first.

{
  "success": true,
  "data": {
    "announcements": [
      {
        "id": "b1c2d3e4-f5a6-4b7c-8d9e-0f1a2b3c4d5e",
        "status_page_id": "0b7c3a52-7d57-4c35-9f0e-5a3b6f1f2a10",
        "title": "Scheduled database upgrade",
        "message": "We will upgrade our database on Saturday at 02:00 UTC.",
        "type": "info",
        "is_published": true,
        "published_at": "2026-09-30T12:00:00.000Z",
        "created_at": "2026-09-30T12:00:00.000Z",
        "updated_at": "2026-09-30T12:00:00.000Z"
      }
    ],
    "total_count": 1
  }
}

cURL

curl https://api.uptimeio.com/api/projects/YOUR_PROJECT_ID/status-pages/YOUR_STATUS_PAGE_ID/announcements \
  -H "X-API-Key: YOUR_API_KEY"

Create an announcement

Field	Type	Required	Description
title	string	Yes	1-200 characters
message	string	Yes	1-5000 characters
type	string	No	info (default), warning, promotion or update
is_published	boolean	No	Default true

Response (201): { "success": true, "data": { "announcement": { ... } } }

cURL

curl -X POST https://api.uptimeio.com/api/projects/YOUR_PROJECT_ID/status-pages/YOUR_STATUS_PAGE_ID/announcements \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Scheduled database upgrade",
    "message": "We will upgrade our database on Saturday at 02:00 UTC.",
    "type": "info"
  }'

Get an announcement

Response (200): { "success": true, "data": { "announcement": { ... } } }

cURL

curl https://api.uptimeio.com/api/projects/YOUR_PROJECT_ID/status-pages/YOUR_STATUS_PAGE_ID/announcements/YOUR_ANNOUNCEMENT_ID \
  -H "X-API-Key: YOUR_API_KEY"

Update an announcement

Send only the fields to change: title, message, type, is_published (same rules as create). Set is_published to false to hide an announcement without deleting it.

Response (200): { "success": true, "data": { "announcement": { ... } } }

cURL

curl -X PATCH https://api.uptimeio.com/api/projects/YOUR_PROJECT_ID/status-pages/YOUR_STATUS_PAGE_ID/announcements/YOUR_ANNOUNCEMENT_ID \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "is_published": false }'

Delete an announcement

Response (200):

{
  "success": true,
  "data": {
    "deleted": true
  }
}

cURL

curl -X DELETE https://api.uptimeio.com/api/projects/YOUR_PROJECT_ID/status-pages/YOUR_STATUS_PAGE_ID/announcements/YOUR_ANNOUNCEMENT_ID \
  -H "X-API-Key: YOUR_API_KEY"

Errors

Status	Code	Cause
400	VALIDATION_ERROR	Invalid body
401	AUTHENTICATION_REQUIRED	Missing or invalid credentials, or insufficient project access (message Access denied)
403	API_KEY_ORGANIZATION_MISMATCH	The API key belongs to a different organization than the project
403	READ_ONLY_API_KEY	The API key has the read scope and the request writes data
404	RESOURCE_NOT_FOUND	The status page or announcement does not exist, or it belongs to a different status page