Update an app install's notification settings
Applies partial changes to the notification settings of the install’s backing app.
Entries in notifications are per-setting deltas: an entry without an id adds a new
setting (label and surfaces required; the id is generated), an entry with only an id
deletes that setting, and an entry with an id plus fields updates the provided fields
of that setting. Settings not referenced are left unchanged; an id that matches no
setting fails with 400. actionLabel, when present, replaces the app’s action label —
send an empty object to clear it. Fails with 404 until the app’s settings are created
via POST or the App Setup page. Requests authenticated with an app API key may only
manage the calling app’s own installs — for a published marketplace app this changes the
app’s settings in every workspace it is installed in. Requests authenticated with a
regular API key require workspace admin privileges.
Authorizations
Path Parameters
Unique identifier of the app install
Body
Notification setting deltas to apply
ActionLabel, when present, replaces the app's action label. Send an empty object to clear it; omit the field to leave it unchanged.
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.
50Response
OK
ActionLabel is the app's generic "[verb] [count] [noun]" label, present only when declared.
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.
"notificationSettings"