Update a Subscription

Request

Modifies existing Subscription.
Only modified attributes may be passed in payload. All other attributes will remain unchanged.

Security

ApiKeyAuth

Path

subdomainstringrequired

Unique subdomain of requested Hub.

subscription_idintegerrequired

id of the subscription to be deleted

Query

api_versionstring

Api version

Value:"V3-R1"

Bodyapplication/json

services_selectionobjectrequired

"all" has precedence over "services". If "all" is false, "services" can't be empty. If "all" is true, "services" value is being ignored

configurationobject

Additional configuration for this method name or this Subscription

Example:

{
  "content_type": "application/json"
}

labelstring or null

Additional information to add better meaning for subscription.
Typically used to add responsible person name or team to SMS or URL-based subscriptions where address alone is not enough to know who is receiving the notifications.
Not available for email subscriptions.

Example:"Responsible person name"

less_verboseboolean

Subscription will receive the minimum number of notifications per incident - typically first and final.

Default:false

Example:true

protectedboolean

Subscription is protected which means it doesn't have the ability of self-service like editing the services list or subscription options as well as doesn't have the ability to self-unsubscribe.
Typically used for group email subscriptions where without this option, any member of an email group could use unsubscribe through the unsubscribe link sent in every notification. And as a result the whole group would stop receiving notifications.

Default:false

Example:false

curl -i -X PUT \
  'https://subdomain-of-your-account.app.statushub.io/api/v3/hubs/{subdomain}/subscriptions/{subscription_id}?api_version=V3-R1' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "services_selection": {
      "all": false,
      "service_ids": [
        449,
        24221,
        2
      ]
    },
    "configuration": {
      "content_type": "application/json"
    },
    "label": "Responsible person name",
    "less_verbose": true,
    "protected": false
  }'

Responses

OK

Bodyapplication/json

idinteger, >= 1

Example:86

addressstring

Address for a subscription. Exact meaning depends on method name:

email - email address,
sms - phone number,
webhook - URL,
slack - Slack Incoming Webhook URL,
teams - MS Teams Incoming Webhook URL.

Example:"example@statushub.com"

configurationobject

Additional configuration for this method name or this Subscription

Example:

{
  "content_type": "application/json"
}

method_namestring

Enum:"email""sms""webhook""slack""teams"

Example:"email"

subscriber_idinteger, >= 1

Example:87

services_selectionobject

flagsBasic flags (object) or Extended flags (object)

One of:

labelstring or null

Additional information to add better meaning for subscription.
Typically used to add responsible person name or team to SMS or URL-based subscriptions where address alone is not enough to know who is receiving the notifications.
Not available for email subscriptions.

Example:"Responsible person name"

created_atstring, (date-time)

Timestamp of record creation.
ISO8601 formatted time (UTC).

Example:"2020-09-01T08:29:00Z"

updated_atstring, (date-time)

Timestamp of last modification of record.
ISO8601 formatted time (UTC).

Example:"2020-09-01T08:29:00Z"

Response

{
  "id": 86,
  "address": "example@statushub.com",
  "configuration": {
    "content_type": "application/json"
  },
  "method_name": "email",
  "subscriber_id": 87,
  "services_selection": {
    "all": true,
    "services": [ … ]
  },
  "flags": {
    "deleted": false
  },
  "label": "Responsible person name",
  "created_at": "2020-09-01T08:29:00Z",
  "updated_at": "2020-09-01T08:29:00Z"
}