Skip to main content
PATCH
Update an app install's notification settings

Authorizations

X-API-KEY
string
header
required

Path Parameters

installId
string
required

Unique identifier of the app install

Body

application/json

Notification setting deltas to apply

actionLabel
object

ActionLabel, when present, replaces the app's action label. Send an empty object to clear it; omit the field to leave it unchanged.

notifications
object[]

Notifications is a list of per-setting deltas: an entry without an id adds a new setting, an entry with an id and no other fields deletes that setting, and an entry with an id plus fields updates the provided fields of that setting.

Maximum array length: 50

Response

OK

actionLabel
object

ActionLabel is the app's generic "[verb] [count] [noun]" label, present only when declared.

notifications
object[]

Notifications is every notification setting the app exposes for this install. Empty when the install's backing app declares no settings. A setting's id is the value to pass as notificationSettingId when creating a notification via POST /v1/notifications. If the recipient's preferences disable every requested delivery target for a setting, that POST creates nothing and returns 202.

object
string
Example:

"notificationSettings"