Skip to main content
POST
Import subscribers

Restrictions

Usage

  • Requires the On-call Professional plan, and the account must also be allowlisted for subscriber import; otherwise the call returns AccessDenied.
  • method must match the page: email for a public page with email subscription enabled, im for an internal page with IM subscription enabled.
  • Each imported recipient’s existing subscriptions on this page are replaced by the imported ones.
  • Every component_ids and change_ids entry must exist on the page; one invalid ID rejects the whole request.
  • Every call is recorded in the account audit log. Don’t put secrets in request fields.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Parameters for bulk-importing subscribers. Each subscriber must have a non-empty recipient (≤255 chars) and subscribe to at least one component, change, or set all: true.

page_id
integer<int64>
required

Target status page ID; obtain it from GET /status-page/list.

method
enum<string>
required

Subscription method. email is only valid for public pages; im is only valid for internal pages.

Available options:
email,
im
subscribers
object[]

Subscribers to import. Each recipient's existing subscriptions on this page are replaced; an empty or omitted list does nothing.

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

No payload. Depending on the operation, data is {} or omitted from the envelope; rely only on the HTTP 200 status and the absence of error.