Status Page Announcement Template

Get Status Page Announcement Template

Endpoint to retrieve a single Status Page Announcement Template by ID

post/status-page-announcement-template/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the Status Page Announcement Template to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "templateName": true,
    "title": true
  }
}

Response

Successful response

Example response

{
  "data": {
    "_id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "version": 42,
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "templateName": "Planned Upgrade Announcement",
    "templateDescription": "This template is used for announcing planned system upgrades and improvements. It provides subscribers with advance notice of upcoming changes and expected impact on service availability.",
    "title": "Scheduled System Upgrade - January 15, 2025",
    "description": "# Heading\n\nThis is **markdown** content",
    "statusPages": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "monitors": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "shouldStatusPageSubscribersBeNotified": true,
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.