Resource

Status Page Announcement Template

Manage announcement templates for your status page

The Status Page Announcement Template Model

Properties

Name
_id
Type
Object ID
Description
ID of this object
Name
createdAt
Type
Date
Description
Date and Time when the object was created.
Name
updatedAt
Type
Date
Description
Date and Time when the object was updated.
Name
project
Type
Project
Description
Relation to Project Resource in which this object belongs
Name
projectId
Type
Object IDRequired
Description
ID of your Project in which this object belongs
Name
templateName
Type
TextRequired
Description
Name of the announcement template
Name
templateDescription
Type
Long Text
Description
Description of the announcement template
Name
title
Type
TextRequired
Description
Title of the announcement
Name
description
Type
MarkdownRequired
Description
Text of the announcement. This is in Markdown.
Name
statusPages
Type
Status Page
Description
Status Pages to show this announcement on.
Name
monitors
Type
Monitor
Description
List of monitors affected by this announcement template. If none are selected, all subscribers will be notified.
Name
shouldStatusPageSubscribersBeNotified
Type
Boolean
Description
Should subscribers be notified about announcements created from this template?
Name
createdByUser
Type
User
Description
Relation to User who created this object (if this object was created by a User)
Name
createdByUserId
Type
Object ID
Description
User ID who created this object (if this object was created by a User)

GETorPOST/api/status-page-announcement-template/get-list

List

This endpoint allows you to retrieve a paginated list of all your Status Page Announcement Template. By default, a maximum of ten Status Page Announcement Template are shown per page.

Optional Query Params

limit
number
Number of objects to fetch. By default 10, you can increase this count up to 100
skip
number
Number of objects to skip. This can be useful in pagination

Optional Request Body

query
If you would like to filter on Status Page Announcement Template. You can specify include a query here. For more information, please check out writing queries here.
select
By default you will only retrieve ID of objects, to retrieve more fields you need to select them. For more information, please check how to select here.
sort
Objects will be sorted based on created date by default. You can change the sort order — see Data Types: Sort.

List Request

POST

/api/status-page-announcement-template/get-list?skip=0&limit=10

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "select": {
    "description": true,
    "projectId": true,
    "templateName": true,
    "title": true,
    "createdByUser": true
  },
  "query": {
    "templateName": "Planned Upgrade Announcement"
  },
  "sort": {
    "createdAt": -1
  }
}

Response

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "377bcae0-28fe-11f1-b591-3fdcef396aba",
      "description": "We will be performing a scheduled system upgrade on **January 15, 2025** from **2:00 AM to 4:00 AM EST**.\n\n## What to Expect\n\n- Brief service interruptions may occur during the maintenance window\n- All data will remain secure and intact\n- System performance improvements will be available after completion\n\n## Affected Services\n\n- API endpoints\n- Web dashboard\n- Mobile applications\n\nWe apologize for any inconvenience and appreciate your patience as we work to improve our services.",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "templateName": "Planned Upgrade Announcement",
      "title": "Scheduled System Upgrade - January 15, 2025",
      "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    {
      "_id": "377bcae1-28fe-11f1-b591-3fdcef396aba",
      "description": "We will be performing a scheduled system upgrade on **January 15, 2025** from **2:00 AM to 4:00 AM EST**.\n\n## What to Expect\n\n- Brief service interruptions may occur during the maintenance window\n- All data will remain secure and intact\n- System performance improvements will be available after completion\n\n## Affected Services\n\n- API endpoints\n- Web dashboard\n- Mobile applications\n\nWe apologize for any inconvenience and appreciate your patience as we work to improve our services.",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "templateName": "Planned Upgrade Announcement",
      "title": "Scheduled System Upgrade - January 15, 2025",
      "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    {
      "_id": "377bcae2-28fe-11f1-b591-3fdcef396aba",
      "description": "We will be performing a scheduled system upgrade on **January 15, 2025** from **2:00 AM to 4:00 AM EST**.\n\n## What to Expect\n\n- Brief service interruptions may occur during the maintenance window\n- All data will remain secure and intact\n- System performance improvements will be available after completion\n\n## Affected Services\n\n- API endpoints\n- Web dashboard\n- Mobile applications\n\nWe apologize for any inconvenience and appreciate your patience as we work to improve our services.",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "templateName": "Planned Upgrade Announcement",
      "title": "Scheduled System Upgrade - January 15, 2025",
      "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  ]
}

GETorPOST/api/status-page-announcement-template/:id/get-item

Get item by ID

This endpoint allows you to retrieve Status Page Announcement Template by ID.

id
text
ID of the Object

Optional Request Body

select
By default you will only retrieve ID of objects, to retrieve more fields you need to select them. For more information, please check how to select here.

Get Item Request

POST

/api/status-page-announcement-template/:id/get-item

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "select": {
    "description": true,
    "projectId": true,
    "templateName": true,
    "title": true,
    "createdByUser": true
  }
}

Response

{
  "_id": "377bcae0-28fe-11f1-b591-3fdcef396aba",
  "description": "We will be performing a scheduled system upgrade on **January 15, 2025** from **2:00 AM to 4:00 AM EST**.\n\n## What to Expect\n\n- Brief service interruptions may occur during the maintenance window\n- All data will remain secure and intact\n- System performance improvements will be available after completion\n\n## Affected Services\n\n- API endpoints\n- Web dashboard\n- Mobile applications\n\nWe apologize for any inconvenience and appreciate your patience as we work to improve our services.",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "templateName": "Planned Upgrade Announcement",
  "title": "Scheduled System Upgrade - January 15, 2025",
  "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

POST/api/status-page-announcement-template/count

Count

This endpoint allows you to retrieve the count of all your Status Page Announcement Template.

Optional Request Body

query
If you would like to filter on Status Page Announcement Template. You can specify include a query here. For more information, please check out writing queries here.

Count Request

POST

/api/status-page-announcement-template/count

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "query": {
    "templateName": "Planned Upgrade Announcement"
  }
}

Response

{
  "count": 107
}

POST/api/status-page-announcement-template

Create Status Page Announcement Template

This endpoint allows you to create a new object.

Create Request

POST

/api/status-page-announcement-template

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "data": {
    "description": "We will be performing a scheduled system upgrade on **January 15, 2025** from **2:00 AM to 4:00 AM EST**.\n\n## What to Expect\n\n- Brief service interruptions may occur during the maintenance window\n- All data will remain secure and intact\n- System performance improvements will be available after completion\n\n## Affected Services\n\n- API endpoints\n- Web dashboard\n- Mobile applications\n\nWe apologize for any inconvenience and appreciate your patience as we work to improve our services.",
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "templateName": "Planned Upgrade Announcement",
    "title": "Scheduled System Upgrade - January 15, 2025",
    "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

Response

{
  "_id": "377bcae0-28fe-11f1-b591-3fdcef396aba",
  "description": "We will be performing a scheduled system upgrade on **January 15, 2025** from **2:00 AM to 4:00 AM EST**.\n\n## What to Expect\n\n- Brief service interruptions may occur during the maintenance window\n- All data will remain secure and intact\n- System performance improvements will be available after completion\n\n## Affected Services\n\n- API endpoints\n- Web dashboard\n- Mobile applications\n\nWe apologize for any inconvenience and appreciate your patience as we work to improve our services.",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "templateName": "Planned Upgrade Announcement",
  "title": "Scheduled System Upgrade - January 15, 2025",
  "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

PUT/api/status-page-announcement-template/:id

Update by ID

This endpoint allows you to update object by its ID.

Alternative Methods

For clients that do not support PUT requests, you can use POST or GET with the same request headers and body:

POST/api/status-page-announcement-template/:id/update-item

GET/api/status-page-announcement-template/:id/update-item

Update Request

PUT

/api/status-page-announcement-template/:id

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "data": {
    "description": "We will be performing a scheduled system upgrade on **January 15, 2025** from **2:00 AM to 4:00 AM EST**.\n\n## What to Expect\n\n- Brief service interruptions may occur during the maintenance window\n- All data will remain secure and intact\n- System performance improvements will be available after completion\n\n## Affected Services\n\n- API endpoints\n- Web dashboard\n- Mobile applications\n\nWe apologize for any inconvenience and appreciate your patience as we work to improve our services.",
    "templateName": "Planned Upgrade Announcement",
    "title": "Scheduled System Upgrade - January 15, 2025"
  }
}

Response

{}

DELETE/api/status-page-announcement-template/:id

Delete by ID

This endpoint allows you to delete object by its ID.

Alternative Methods

For clients that do not support DELETE requests, you can use POST or GET with the same request headers and body:

POST/api/status-page-announcement-template/:id/delete-item

GET/api/status-page-announcement-template/:id/delete-item

Delete Request

DELETE

/api/status-page-announcement-template/:id

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Response

{}

Permissions

Your API Token needs permissions to create, update, read or delete this resource. If you do not have permissions to make a request a 4xx status will be sent as response.

Read Permissions

Required to read Status Page Announcement Template

Project Owner
Project Admin
Project Member
Read Status Page Announcement Template
Read All Project Resources

Create Permissions

Required to create Status Page Announcement Template

Project Owner
Project Admin
Project Member
Create Status Page Announcement Template

Update Permissions

Required to update Status Page Announcement Template

Project Owner
Project Admin
Project Member
Edit Status Page Announcement Template

Delete Permissions

Required to delete Status Page Announcement Template

Project Owner
Project Admin
Project Member
Delete Status Page Announcement Template