AlertDescriptorSettings document (Data API 19.8)

Document describing settings for a single alert descriptor.

Property Type Constraints Description
application_context_path String mandatory=true, minLength=1, nullable=false The application context path.
application_id String mandatory=true, minLength=1, nullable=false The application ID.
is_user_override Boolean mandatory=true, nullable=false

Flag that indicates whether the settings for this descriptor have been changed by the user.

In a PATCH request, this flag must be set to true to override the default settings. If this flag to false in a PATCH request, the default user settings for this descriptor are restored (and all other fields are ignored).

message_id String mandatory=true, minLength=1, nullable=false The message ID.
priority Enum {hidden, informational, warning, action_required} mandatory=true, nullable=false The user priority.
show_in_header Boolean mandatory=true, nullable=false Flag that indicates whether the alert is shown in the Business Manager header.
show_on_homepage Boolean mandatory=true, nullable=false Flag that indicates whether the alert is shown on the Business Manager homepage.