Notice Updates

Each Notice on your page can have multiple updates, each describing the current situation.

Note: Creating a new update on a notice will trigger their publication not only to the Status Page but also to any configured integrations such as X (Twitter), Email, SMS, MS Teams, Slack and Google Chat.

Endpoints

https://api.sorryapp.com/v1/pages/:page_id/notices/:notice_id/updates/
https://api.sorryapp.com/v1/pages/:page_id/notices/:notice_id/updates/:update_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 update.

  • Name
    content
    Description

    The text content for this particular update.

  • Name
    should_publish
    Description

    Boolean, was this update sent out through Email, Slack Twitter etc.

  • Name
    created_at
    Description

    The date/time the record was created.

  • Name
    updated_at
    Description

    The date/time the record was last updated.


GET/v1/pages/:page_id/notices/:notice_id/updates

List updates

This endpoint displays a list of all updates in a single notice.

Request

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

Response

{
"response": [
    {
        "id": 51028044,
        "content": "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-02-04T10:27:51.719Z",
        "should_publish": true,
        "link": "https://status.acme.com/notices/bctcgnfwreop8l6x-we-re-currently-having-issues/#update-51028044",
        "updated_at": "2025-02-04T10:27:51.719Z"
    },
    {
        "id": 51028046,
        "content": "We've now resolved the incident. Thanks for your patience.",
        "created_at": "2025-02-04T10:28:55.651Z",
        "should_publish": false,
        "link": "https://status.acme.com/notices/bctcgnfwreop8l6x-we-re-currently-having-issues/#update-51028046",
        "updated_at": "2025-02-04T10:28:55.651Z"
    }
],
"count": 2
}

Including components

To include a list of affected components in a notice, append ?include=components onto the end of the endpoint. This will return an array list of components.

Request

GET
/v1/pages/12ab34cd/notices?include=components
curl -X GET https://api.sorryapp.com/v1/pages/12ab34cd/notices?include=components \
-H "Authorization: Bearer {token}"

POST/v1/pages/:page_id/notices/:notice_id/updates

Create a new update

This endpoint allows you to publish a new update to the notice.

Request

POST
/v1/pages/12ab34cd/notices/433244/updates
curl -X POST https://api.sorryapp.com/v1/pages/12ab34cd/notices/433244/updates \
-d content="We are still investigating issues accessing the API on version 1." \
-H "Authorization: Bearer {token}"

Response

{
"response": {
    "id": 51028119,
    "content": "We are still investigating issues accessing the API on version 1.",
    "created_at": "2025-02-04T14:28:30.136Z",
    "should_publish": true,
    "link": "https://status.acme.com/notices/r9cjlguanrtr5duc-api-v1-performance-issues/#update-51028119",
    "updated_at": "2025-02-04T14:28:30.136Z"
}
}

GET/v1/pages/:page_id/notices/:notice_id/updates/:update_id

Retrieve a notice update

This endpoint allows you to retrieve the details of a single update.

Request

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

Response

{
"response": {
    "id": 51028119,
    "content": "We are still investigating issues accessing the API on version 1.",
    "created_at": "2025-02-04T14:28:30.136Z",
    "should_publish": true,
    "link": "https://status.acme.com/notices/r9cjlguanrtr5duc-api-v1-performance-issues/#update-51028119",
    "updated_at": "2025-02-04T14:28:30.136Z"
}
}

PATCH/v1/pages/:page_id/notices/:notice_id/updates/:update_id

Edit a notice

This endpoint allows you to update the details of a single update, such as correcting the content.

Request

PATCH
/v1/pages/12ab34cd/notices/433244
curl -X PATCH https://api.sorryapp.com/v1/pages/12ab34cd/notices/433244/updates/51028119 \
-d content="We are still investigating issues with 503 errors whilst using v1 API" \
-H "Authorization: Bearer {token}"

Response

{
"response": {
    "id": 51028119,
    "content": "We are still investigating issues with 503 errors whilst using v1 API",
    "created_at": "2025-02-04T14:28:30.136Z",
    "should_publish": true,
    "link": "https://status.acme.com/notices/r9cjlguanrtr5duc-api-v1-performance-issues/#update-51028119",
    "updated_at": "2025-02-04T14:40:07.442Z"
}
}

DELETE/v1/pages/:page_id/notices/:notice_id/updates/:update_id

Delete a notice update

This endpoint allows you to delete the a component. Note that this does not delete associated notices.

Request

DELETE
/v1/pages/12ab34cd/notices/433244/updates/51028119
curl -X DELETE https://api.sorryapp.com/v1/pages/12ab34cd/notices/433244/updates/51028119 \ 
-H "Authorization: Bearer {token}"