Notification App Setting

Notification app settings have default values that come from the notification type definition and application settings. Admins can disable standard notification app settings that are enabled by default; however, they can’t enable standard notification app settings that are disabled by default. If your app accepts custom notification app settings, admins can enable custom notification app settings that are disabled by default.

Resource

/connect/notifications/app-settings/organization/notificationTypeOrId

Available version

47.0

HTTP methods

GET, POST, DELETE

Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
applicationId	String	ID of the connected app or external client app. If not specified and called from a connected app or external client app, defaults to the app information from the session.	Optional	47.0

Response body for GET

Notification App Settings Collection

Request body for POST

Use POST to set a notification app setting.

Root XML tag

<notificationAppSetting>

JSON example

{
   "enabled":"false"
}

Properties

Starting in API version 64.0, the Notification App Setting Input request body supports external client apps, in addition to connected apps. Mobile, push notification, and notification plugins for external client apps (beta) are available in API version 64.0.

Note

Name	Type	Description	Required or Optional	Available Version
applicationId	String	ID of the connected app or external client app. If not specified and called from a connected app or external client app, defaults to the app information from the session.	Optional	47.0
enabled	Boolean	Specifies whether to enable delivery of the notification type for the connected app or external client app (true) or not (false).	Optional	47.0

Request parameters for POST

Parameter Name	Type	Description	Required or Optional	Available Version
applicationId	String	ID of the connected app or external client app. If not specified and called from a connected app or external client app, defaults to the app information from the session.	Optional	47.0
enabled	Boolean	Specifies whether to enable delivery of the notification type for the connected app or external client app (true) or not (false).	Optional	47.0

Response body for POST

Notification App Setting

Request parameters for DELETE

Use DELETE to reset a notification app setting to the default.

Parameter Name	Type	Description	Required or Optional	Available Version
applicationId	String	ID of the connected app or external client app. If not specified and called from a connected app or external client app, defaults to the app information from the session.	Optional	40.0

Response for DELETE

204: Successful Delete