Notice Templates

Quickly start writing notices with pre-defined templates, keeping a consistent tone. This endpoint allows you to create, update and delete templates via the API.

Endpoint

https://api.sorryapp.com/v1/pages/:page_id/notice_templates/

https://api.sorryapp.com/v1/pages/:page_id/notices/:notice_template_id

Objects

These are the attributes which represent the object, most of which can be posted too and received in response to the available methods.

Properties

Name
id
Description
The unique identifier for the notice template
Name
name
Description
The name of the template.
Name
subject
Description
The subject for the notice i.e. API Performance Issues
Name
initial_comment
Description
Pass this to create a single update to introduce the notice.

GET/v1/pages/:page_id/notice_templates

List templates

This endpoint displays a list of the templates associated to a status page

Request

GET

'/v1/pages/:page_id/notice_templates

curl -X GET https://api.sorryapp.com/v1/pages/12ab34cd/notice_templates \
-H "Authorization: Bearer {token}"

Response

{
"response": [
    {
        "id": "7RCO7J",
        "name": "Planned Maintenance (Example)",
        "subject": "Upcoming maintenance",
        "initial_comment": "While we do not expect any service interruptions, we are running maintenance behind the scenes during this period. We'll keep you updated as things progress.",
        "created_at": "2025-06-20T13:58:07.778Z",
        "updated_at": "2025-06-20T13:58:07.778Z"
    },
    {
        "id": "DzCQmk",
        "name": "Current Incident (Example)",
        "subject": "We're currently having issues",
        "initial_comment": "Some people are experiencing problems with our service right now. We're so sorry about that. Please standby for further updates, and we'll be in touch as soon as we know more.",
        "created_at": "2025-06-20T13:58:07.780Z",
        "updated_at": "2025-06-20T13:58:07.780Z"
    },
 ],
 "count": 2,
 "pagination": {
   "current": 1,
   "previous": null,
   "next": null,
   "per_page": 25,
   "pages": 1,
   "count": 2
 }
}

GET/v1/pages/:page_id/notice_templates

Filter templates

You can search for specific templates by filtering based on the name. Learn more about filtering with the REST API.

Request

GET

'/v1/pages/:page_id/notice_templates

curl -X GET https://api.sorryapp.com/v1/pages/12ab34cd/notice_templates \
-d "filter[name_cont]=Planned" \
-H "Authorization: Bearer {token}"

Response

{
"response": [
    {
        "id": "7RCO7J",
        "name": "Planned Maintenance (Example)",
        "subject": "Upcoming maintenance",
        "initial_comment": "While we do not expect any service interruptions, we are running maintenance behind the scenes during this period. We'll keep you updated as things progress.",
        "created_at": "2025-06-20T13:58:07.778Z",
        "updated_at": "2025-06-20T13:58:07.778Z"
    }
],
"count": 1,
"pagination": {
    "current": 1,
    "previous": null,
    "next": null,
    "per_page": 25,
    "pages": 1,
    "count": 1
}
}                                                                                                                  nic@Nics-Mac-mini Code %

POST/v1/pages/:page_id/notice_templates

Create a template

This endpoint allows you to create a notice template.

Request

POST

/v1/pages/:page_id/notice_templates

curl -X POST https://api.sorryapp.com/v1/pages/12ab34cd/notice_templates \
  -d "name=My API Template" \
  -d "subject=Subject for the notice template" \
  -d "initial_comment=This is the opening comment for the notice." \
  -H "Authorization: Bearer {token}"

Response

{
  "response": {
    "id": "6lC9ba",
    "name": "My API Template",
    "subject": "Subject for the notice template",
    "initial_comment": "This is the opening comment for the notice.",
    "created_at": "2025-06-23T08:21:25.771Z",
    "updated_at": "2025-06-23T08:21:25.771Z"
  }
}

GET/v1/pages/:page_id/notice_templates/:notice_template_id

Retrieve a template

This endpoint retrieves a single notice template.

Request

GET

/v1/pages/:page_id/notice_templates/:notice_template_id

curl -X GET https://api.sorryapp.com/v1/pages/12ab34cd/notice_templates/loCPQb \
-H "Authorization: Bearer {token}"

Response

{
 "response": {
    "id": "loCPQb",
    "name": "Test Incident (Example)",
    "subject": "Testing the Status Page",
    "initial_comment": "Don't worry; there's nothing wrong with our service, we're just testing our status page. We'll use this page to keep people informed of any real incidents, or maintenance we have planned.",
    "created_at": "2025-06-20T13:58:07.772Z",
    "updated_at": "2025-06-20T13:58:07.772Z"
  }
}

PATCH/v1/pages/:page_id/notice_templates/:notice_template_id

Update a template

This endpoint allows you to update a single notice template such as it's name, subject or initial comment.

Request

PATCH

v1/pages/12ab34cd/notice_templates/loCPQb

curl -X PATCH https://api.sorryapp.com/v1/pages/12ab34cd/notice_templates/loCPQb \
  -d "subject=Updated subject for template" \
  -H "Authorization: Bearer {token}"

Response

{
 "response": {
    "id": "loCPQb",
    "name": "Test Incident (Example)",
    "subject": "Updated subject for template",
    "initial_comment": "Don't worry; there's nothing wrong with our service, we're just testing our status page. We'll use this page to keep people informed of any real incidents, or maintenance we have planned.",
    "created_at": "2025-06-20T13:58:07.772Z",
    "updated_at": "2025-06-23T12:20:42.326Z"
  }
}

DELETE/v1/pages/:page_id/notice_templates/:notice_template_id

Delete a template

This endpoint allows you to delete the notice template.

Request

DELETE

/v1/pages/12ab34cd/notice_templates/loCPQb

curl -X DELETE https://api.sorryapp.com/v1/pages/12ab34cd/notice_templates/loCPQb \
-H "Authorization: Bearer {token}"