Skip to main content
PUT
Turn an alert channel on or off

Authorizations

X-API-Key
string
header
required

Path Parameters

channel_type
enum<string>
required

Delivery channel: email, sms or in_app.

Available options:
email,
sms,
in_app

Body

application/json
enabled
boolean
required

Turn the channel on or off.

Response

OK

email
boolean
required

Email alerts are on.

sms
boolean
required

Text message alerts are on.

in_app
boolean
required

In-app alerts are on.

has_sms_channel
boolean
required

Whether a phone number has ever been set up.

sms_number
string | null

The verified number receiving texts, formatted for display.