ONoneuptime
Status Page Announcement

Update Status Page Announcement

Endpoint to update an existing Status Page Announcement

put/status-page-announcement/{id}

Request

Path parameters

idstring uuid required

ID of the Status Page Announcement to update

Request body

Example request

{
  "data": {
    "title": "Example Text",
    "showAnnouncementAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "description": null
  }
}

Response

Updated successfully

Example response

{
  "data": {
    "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "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"
    },
    "project": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "statusPages": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "monitors": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "title": "Example Text",
    "showAnnouncementAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "endAnnouncementAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "description": null,
    "attachments": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "createdByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "createdByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "deletedByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "subscriberNotificationStatusMessage": "This is an example of longer text content that provides detailed information.",
    "shouldStatusPageSubscribersBeNotified": true
  }
}

Changes

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