Update Templates

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

Endpoint

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

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 update template
Name
name
Description
The name of the template.
Name
content
Description
Pass this to create a single update.

GET/v1/pages/:page_id/update_templates

List update templates

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

Request

GET

'/v1/pages/:page_id/update_templates

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

Response

{
"response": [
    {
        "id": "vlliev",
        "name": "Incident - App Update",
        "content": "We're actively investigating reports of [issue description]. Our team is working to identify the root cause. Estimated resolution: [timeframe]. Updates in [X] minutes.",
        "created_at": "2025-11-27T15:31:58.789Z",
        "updated_at": "2025-11-27T15:31:58.789Z"
    },
    {
        "id": "RYNiMk",
        "name": "Incident - App Resolved",
        "subject": "We're currently having issues",
        "content": "The issue affecting the app has been resolved and is now operating normally. We apologise for any inconvenience. Please contact support if problems persist.",
        "created_at": "2025-11-27T15:32:39.669Z",
        "updated_at": "2025-11-27T15:32:39.669Z"
    },
 ],
 "count": 2,
 "pagination": {
   "current": 1,
   "previous": null,
   "next": null,
   "per_page": 25,
   "pages": 1,
   "count": 2
 }
}

GET/v1/pages/:page_id/update_templates

Filter update 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/update_templates

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

Response

{
"response": [
    {
        "id": "RYNiMk",
        "name": "Incident - App Resolved",
        "content": "The issue affecting the app has been resolved and is now operating normally. We apologise for any inconvenience. Please contact support if problems persist.",
        "created_at": "2025-11-27T15:32:39.669Z",
        "updated_at": "2025-11-27T15:32:39.669Z"
    }
],
"count": 1,
"pagination": {
    "current": 1,
    "previous": null,
    "next": null,
    "per_page": 25,
    "pages": 1,
    "count": 1
}
}

POST/v1/pages/:page_id/update_templates

Create an update template

This endpoint allows you to create an update notice template.

Request

POST

/v1/pages/:page_id/update_templates

curl -X POST https://api.sorryapp.com/v1/pages/12ab34cd/update_templates \
  -d "name=Maintenance - Rescheduled" \
  -d "content=We have rescheduled this maintenance to another month." \
  -H "Authorization: Bearer {token}"

Response

{
  "response": {
    "id": "blli1X",
    "name": "Maintenance - Rescheduled",
    "content": "We have rescheduled this maintenance to another month.",
    "created_at": "2025-11-27T15:31:58.789Z",
    "updated_at": "2025-11-27T15:31:58.789Z"
  }
}

PATCH/v1/pages/:page_id/update_templates/:update_template_id

Update an update 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/update_templates/vlliev

curl -X PATCH https://api.sorryapp.com/v1/pages/12ab34cd/update_templates/vlliev \
  -d "content=We're actively investigating reports of issues with the app. Our team is working to identify the root cause. Next update will be [X] minutes." \
  -H "Authorization: Bearer {token}"

Response

{
 "response": {
    "id": "vlliev",
    "name": "Incident - App Update",
    "content": "We're actively investigating reports of issues with the app. Our team is working to identify the root cause. Next update will be [X] minutes.",
    "created_at": "2025-11-27T15:31:58.789Z",
    "updated_at": "2025-11-27T15:31:58.789Z"
  }
}

DELETE/v1/pages/:page_id/update_templates/:update_template_id

Delete an update template

This endpoint allows you to delete the update notice template.

Request

DELETE

/v1/pages/12ab34cd/update_templates/vlliev

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