ONoneuptime
Status Page Subscriber

Update Status Page Subscriber

Endpoint to update an existing Status Page Subscriber

put/status-page-subscriber/{id}

Request

Path parameters

idstring uuid required

ID of the Status Page Subscriber to update

Request body

Example request

{
  "data": {}
}

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",
    "statusPage": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "statusPageId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "subscriberEmail": "user@example.com",
    "subscriberPhone": "+1-555-0123",
    "subscriberWebhook": "https://example.com",
    "slackWorkspaceName": "Example Text",
    "microsoftTeamsWorkspaceName": "This is an example of longer text content that provides detailed information.",
    "language": "Example Text",
    "createdByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "createdByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "deletedByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "isSubscriptionConfirmed": true,
    "isUnsubscribed": true,
    "unsubscribedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "isAddedByTeam": true,
    "sendYouHaveSubscribedMessage": true,
    "isSubscribedToAllResources": true,
    "isSubscribedToAllEventTypes": true,
    "statusPageResources": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "statusPageEventTypes": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "internalNote": null
  }
}

Changes

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