Skip to content

Update a notification's settings

PATCH
/types/{notificationId}

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
notificationId
required
string

The notification ID

Request Body required

Section titled “Request Body required ”
object
title
string
channels
Array<string>
Allowed values: EMAIL INAPP_WEB SMS CALL PUSH WEB_PUSH SLACK
enabled
boolean
deduplication
object
duration
required
number
throttling
object
max
required
number
period
required
number
unit
required
string
Allowed values: seconds minutes hours days months years
forever
required
boolean
scope
required
Array<string>
>= 2 items <= 2 items
Allowed values: userId notificationId
retention
number
nullable
options
object
EMAIL
object
defaultDeliveryOption
required
string
Allowed values: off instant hourly daily weekly monthly
off
object
enabled
required
boolean
instant
object
enabled
required
boolean
hourly
object
enabled
required
boolean
daily
object
enabled
required
boolean
hour
string
weekly
object
enabled
required
boolean
hour
string
day
string
monthly
object
enabled
required
boolean
hour
string
date
string
Allowed values: first last
INAPP_WEB
object
defaultDeliveryOption
required
string
Allowed values: off instant
off
object
enabled
required
boolean
instant
object
enabled
required
boolean
batching
boolean
batchingKey
string
batchingWindow
number
SMS
object
defaultDeliveryOption
required
string
Allowed values: off instant hourly daily weekly monthly
off
object
enabled
required
boolean
instant
object
enabled
required
boolean
hourly
object
enabled
required
boolean
daily
object
enabled
required
boolean
hour
string
weekly
object
enabled
required
boolean
hour
string
day
string
monthly
object
enabled
required
boolean
hour
string
date
string
Allowed values: first last
CALL
object
defaultDeliveryOption
required
string
Allowed values: off instant hourly daily weekly monthly
off
object
enabled
required
boolean
instant
object
enabled
required
boolean
hourly
object
enabled
required
boolean
daily
object
enabled
required
boolean
hour
string
weekly
object
enabled
required
boolean
hour
string
day
string
monthly
object
enabled
required
boolean
hour
string
date
string
Allowed values: first last
PUSH
object
defaultDeliveryOption
required
string
Allowed values: off instant hourly daily weekly monthly
off
object
enabled
required
boolean
instant
object
enabled
required
boolean
hourly
object
enabled
required
boolean
daily
object
enabled
required
boolean
hour
string
weekly
object
enabled
required
boolean
hour
string
day
string
monthly
object
enabled
required
boolean
hour
string
date
string
Allowed values: first last
WEB_PUSH
object
defaultDeliveryOption
required
string
Allowed values: off instant hourly daily weekly monthly
off
object
enabled
required
boolean
instant
object
enabled
required
boolean
hourly
object
enabled
required
boolean
daily
object
enabled
required
boolean
hour
string
weekly
object
enabled
required
boolean
hour
string
day
string
monthly
object
enabled
required
boolean
hour
string
date
string
Allowed values: first last
SLACK
object
defaultDeliveryOption
required
string
Allowed values: off instant hourly daily weekly monthly
off
object
enabled
required
boolean
instant
object
enabled
required
boolean
hourly
object
enabled
required
boolean
daily
object
enabled
required
boolean
hour
string
weekly
object
enabled
required
boolean
hour
string
day
string
monthly
object
enabled
required
boolean
hour
string
date
string
Allowed values: first last

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful response

object
envId
required
string
notificationId
required
string
title
required
string
channels
required
Array<string>
Allowed values: EMAIL INAPP_WEB SMS CALL PUSH WEB_PUSH SLACK
enabled
required
boolean
deduplication
object
duration
required
number
throttling
object
max
required
number
period
required
number
unit
required
string
Allowed values: seconds minutes hours days months years
forever
required
boolean
scope
required
Array<string>
>= 2 items <= 2 items
Allowed values: userId notificationId
retention
number
options
object
EMAIL
object
defaultDeliveryOption
required
string
Allowed values: off instant hourly daily weekly monthly
off
object
enabled
required
boolean
instant
object
enabled
required
boolean
hourly
object
enabled
required
boolean
daily
object
enabled
required
boolean
hour
string
weekly
object
enabled
required
boolean
hour
string
day
string
monthly
object
enabled
required
boolean
hour
string
date
string
Allowed values: first last
INAPP_WEB
object
defaultDeliveryOption
required
string
Allowed values: off instant
off
object
enabled
required
boolean
instant
object
enabled
required
boolean
batching
boolean
batchingKey
string
batchingWindow
number
SMS
object
defaultDeliveryOption
required
string
Allowed values: off instant hourly daily weekly monthly
off
object
enabled
required
boolean
instant
object
enabled
required
boolean
hourly
object
enabled
required
boolean
daily
object
enabled
required
boolean
hour
string
weekly
object
enabled
required
boolean
hour
string
day
string
monthly
object
enabled
required
boolean
hour
string
date
string
Allowed values: first last
CALL
object
defaultDeliveryOption
required
string
Allowed values: off instant hourly daily weekly monthly
off
object
enabled
required
boolean
instant
object
enabled
required
boolean
hourly
object
enabled
required
boolean
daily
object
enabled
required
boolean
hour
string
weekly
object
enabled
required
boolean
hour
string
day
string
monthly
object
enabled
required
boolean
hour
string
date
string
Allowed values: first last
PUSH
object
defaultDeliveryOption
required
string
Allowed values: off instant hourly daily weekly monthly
off
object
enabled
required
boolean
instant
object
enabled
required
boolean
hourly
object
enabled
required
boolean
daily
object
enabled
required
boolean
hour
string
weekly
object
enabled
required
boolean
hour
string
day
string
monthly
object
enabled
required
boolean
hour
string
date
string
Allowed values: first last
WEB_PUSH
object
defaultDeliveryOption
required
string
Allowed values: off instant hourly daily weekly monthly
off
object
enabled
required
boolean
instant
object
enabled
required
boolean
hourly
object
enabled
required
boolean
daily
object
enabled
required
boolean
hour
string
weekly
object
enabled
required
boolean
hour
string
day
string
monthly
object
enabled
required
boolean
hour
string
date
string
Allowed values: first last
SLACK
object
defaultDeliveryOption
required
string
Allowed values: off instant hourly daily weekly monthly
off
object
enabled
required
boolean
instant
object
enabled
required
boolean
hourly
object
enabled
required
boolean
daily
object
enabled
required
boolean
hour
string
weekly
object
enabled
required
boolean
hour
string
day
string
monthly
object
enabled
required
boolean
hour
string
date
string
Allowed values: first last
templates
Array<object>
object
channel
required
string
Allowed values: EMAIL INAPP_WEB SMS CALL PUSH WEB_PUSH SLACK
templateIds
required
Array<string>

400

Section titled “400 ”

Bad Request - validation errors, invalid input

Standard error response for API errors.

object
trackingId
required

Unique tracking ID for the request.

string
error
required

Structured error details for API error responses.

object
code
required

Machine-readable error code.

string
message
required

Human-readable error message.

string
fix

Actionable hint for fixing the error.

string
provider

Provider that caused the error (e.g. telnyx, ses).

string
providerCode

Provider-specific error code.

string

401

Section titled “401 ”

Unauthorized

402

Section titled “402 ”

Payment Required - usage limits exceeded

Standard error response for API errors.

object
trackingId
required

Unique tracking ID for the request.

string
error
required

Structured error details for API error responses.

object
code
required

Machine-readable error code.

string
message
required

Human-readable error message.

string
fix

Actionable hint for fixing the error.

string
provider

Provider that caused the error (e.g. telnyx, ses).

string
providerCode

Provider-specific error code.

string

500

Section titled “500 ”

Internal Server Error

502

Section titled “502 ”

Bad Gateway - provider error

Standard error response for API errors.

object
trackingId
required

Unique tracking ID for the request.

string
error
required

Structured error details for API error responses.

object
code
required

Machine-readable error code.

string
message
required

Human-readable error message.

string
fix

Actionable hint for fixing the error.

string
provider

Provider that caused the error (e.g. telnyx, ses).

string
providerCode

Provider-specific error code.

string