ATatlassian
Status Page

Create subscriber

Add a new subscriber for status page.

post/stakeholder-comms/cloudId/{cloudId}/api/subscribers

Request

  • Base URL
    https://api.atlassian.com/jsm/ops
  • URL
    https://api.atlassian.com/jsm/ops/stakeholder-comms/cloudId/{cloudId}/api/subscribers
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.stg.atlassian.com/authorize
      Token URL: https://auth.stg.atlassian.com/oauth/token scopes: write:stakeholder-comms.subscriber:jira-service-management

Request body

Response

Returned if the subscriber is successfully created.

idstring

Identifier of the subscriber.

itemIdstring

Identifier of the subscribed item (page, incident, component).

type'INCIDENT_SUBSCRIBER' | 'PAGE_SUBSCRIBER' | 'COMPONENT_SUBSCRIBER'

Subscription item type.

status'PENDING_CONFIRMATION' | 'SUBSCRIBED' | 'UNSUBSCRIBED' | 'SUSPENDED' | 'DEACTIVATED' | 'QUARANTINED' | 'UNVERIFIED'

Status of the subscriber.

emailstring

Email address of the subscriber.

phoneNumberstring

Phone number for SMS notifications.

phoneCountrystring

Country code for the phone number.

componentIdsstring[]

Component identifiers the subscriber is interested in.

webhookEndpointstring

Webhook URL for notifications.

skipConfirmationboolean

Whether email confirmation was skipped.

pageAccessUserIdstring

Page-access user identifier.

phoneNumberDisplaystring

Formatted phone number for display.

deactivatedAtstring date-time

When the subscriber was deactivated.

orphanedAtstring date-time

When the subscriber became orphaned.

quarantinedAtstring date-time

When the subscriber was quarantined.

confirmedAtstring date-time

When the subscriber confirmed their subscription.

confirmationCodestring

Confirmation code sent to the subscriber.

shortCodeSubscriptionIdstring

Short code subscription identifier.

lastRemindedAtstring date-time

When the last reminder was sent.

subscriptionType'EMAIL' | 'SMS' | 'WEBHOOK' | 'SLACK'

Subscription channel.

additionalInformationstring[]

Additional information strings for the subscription.

slackChannelIdstring

Slack channel identifier.

slackUserIdstring

Slack user identifier.

createdAtstring date-time

When the subscriber was created.

updatedAtstring date-time

When the subscriber was last updated.

Changes

No recorded changes to this operation across all 5 revisions of this API.