HomeRelease Notes
API Reference
API Reference

Create Subscriber

post
https://{domain}/api/v4/subscriber
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The input.

SubscriptionCreate

string
enum

Subscription Role Type

Members:

  • Subscriber - Subscriber
  • Employee - Employee

Allowed:
string | null

The email address of the subscription

string | null

The phone number of the subscription

string | null

The webhook url of the subscription

string | null

The tags for a subscription

boolean | null

Whether of not to receive montly summaries

boolean | null

Notify the subscriber that a subscription was created

components
array of int32s | null

The components the subscription is associated with

components
groups
array of int32s | null

The groups the subscription is associated with

groups
boolean | null

Whether or not to create a login in account for the subscription

boolean | null

Whether or not the subscription requires activation

boolean | null

Whether or not the subscription should receive webhook notifications

boolean | null

Whether or not the subscription should receive email notifications

boolean | null

Whether or not the subscription should receive sms notifications

boolean | null

Whether or not the subscription should receive email service disruption incident notifications

boolean | null

Whether or not the subscription should receive email scheduled maintenance incident notifications

boolean | null

Whether or not the subscription should receive email informational incident notifications

boolean | null

Whether or not the subscription should receive sms service disruption incident notifications

boolean | null

Whether or not the subscription should receive sms scheduled maintenance incident notifications

boolean | null

Whether or not the subscription should receive sms scheduled maintenance incident notifications

Responses

401

Unauthorized

403

Forbidden

405

NotAllowed

Updated over 1 year ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago