Sign in

v1

latestOpenAPI 3.1.02026-08-06360288.3 KB
Subscribers

Update Subscriber

Update an existing subscriber's address or granular notification preferences.

patch/subscriber/update

Headers

x-api-idstring required
x-api-keystring required

Request body

statuspage_idstring required

ID of the status page

subscriber_idstring required

ID of the subscriber

addressstring

Subscriber address (SMS numbers must include country code, e.g., +1)

granularstring

Choose which components and data centers to receive notifications for. Comma-separated list of component_container combinations.

Example request

{
  "address": "alerts@acme-corp.com",
  "granular": "54d44a5bfc9259df1000000f_54d44a42fc9259df10000008,54d44a36fc9259df10000005_54d3162f750e87b398000015",
  "statuspage_id": "52e5e0e0873548543700000b",
  "subscriber_id": "5511b3cbb066c9d14e000005"
}

Response

OK

Example response

{
  "result": {
    "__v": 0,
    "_id": "5511b3cbb066c9d14e000005",
    "active": true,
    "address": "alerts@acme-corp.com",
    "granular": [
      "54d44a5bfc9259df1000000f_54d44a42fc9259df10000008",
      "54d44a36fc9259df10000005_54d3162f750e87b398000015"
    ],
    "join_date": "2015-09-19T22:39:28.476Z",
    "method": "email",
    "statuspage": "52e5e0e0873548543700000b",
    "subscriber_id": "5511b3cbb066c9d14e000005"
  },
  "status": {
    "error": "no",
    "message": "OK"
  }
}