Turn a disabled chat or webhook subscriber back on. Its failure count starts again from zero.

POST

/status_page/{status_page_id}/subscriber/{subscriber_id}/enable

const url = 'https://api.siteqwality.com/status_page/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/subscriber/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/enable';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.siteqwality.com/status_page/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/subscriber/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/enable \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer_auth

Parameters

Path Parameters

status_page_id

required

string format: uuid

Status page identifier

subscriber_id

required

string format: uuid

Subscriber identifier

Responses

200

The subscriber, enabled

application/json

Someone who gets a status page’s updates by email, chat or webhook.

object

required

string

email

The address. Null for a chat or webhook subscriber.

string | null

channel

email, slack, teams, discord, google_chat or webhook.

string

Allowed values: email slack teams discord google_chat webhook

destination

A chat or webhook subscriber’s URL, masked: its host and the last four characters.

string | null

state

required

confirmed receives notices. pending has not clicked the link yet. queued was imported and waits for its confirmation email. expired never clicked, and the link lapsed. quarantined bounced or complained and gets nothing. disabled is a chat or webhook subscriber whose endpoint refused or kept failing; enable it to resume.

string

Allowed values: confirmed pending queued expired quarantined disabled

consecutive_failures

Chat and webhook deliveries that failed in a row; 5 disables the subscriber.

integer format: int32

disabled_at

string | null format: date-time

disabled_reason

Why it was disabled.

string | null

subscribed_at

required

When the address was first submitted.

string format: date-time

confirmed_at

string | null format: date-time

component_ids

Components (monitor ids) whose notices it gets. Empty means every component.

Array<string>

kinds

Kinds of update it gets. Empty means both.

Array<string>

Allowed values: incident maintenance

consent_source

One of:

string
null

How the address was added. Absent on subscribers from before it was recorded.

string

Allowed values: public_form owner_add import

consent_version

The version of the confirm page wording it agreed to, set when it confirms.

string | null

quarantined_at

string | null format: date-time

quarantine_reason

One of:

string
null

Why an address gets nothing. A complaint is never lifted automatically.

string

Allowed values: bounce complaint

Example

{
  "channel": "email",
  "state": "confirmed",
  "kinds": [
    "incident"
  ],
  "consent_source": "public_form",
  "quarantine_reason": "bounce"
}

401

Missing or invalid authentication

404

Status page or subscriber not found

500

Internal server error