Notificationtemplate

Class: metadata

Defines a template for email and notification messages sent by Vault.

Notification templates use special pieces of text called tokens. When sending a notification, Vault replaces the token with the values it represents. Learn about Notification Messages in Vault Help.

Attribute	Metadata	Description
`label`	Type: String Required Max length: 40	UI-friendly string in the Vault's base language.
`active`	Type: Boolean Required	Indicates whether the component is active.
`description`	Type: String Max length: 255	Additional description of the notification template.
`subject`	Type: String Required Max length: 255	Subject of the email sent to the recipient.
`notification`	Type: String Required Max length: 1023	The message that appears in Vault's notification page for the recipient.
`email_body`	Type: String Required Max length: 2147483647	Body of the email sent to the notification recipient.
`email_preferences`	Type: String Max length: 255	The frequency with which Vault sends emails. If omitted or empty, the default value is `summary__sys`. Learn more about summary emails in Vault Help.
`entity_type`	Type: Enum Required Allowed values: document object custom	Indicates whether the message is intended for documents or objects.
`notification_category`	Type: String Max length: 255
`referenced_component`	Type: Component	The specific Object (when `entity_type` is `object`).

Supported Operations

Operation	Support
Create
Recreate
Alter
Drop	^*
Rename
Describe
Generate Recreate
Queryable

Notes:

Drop: MDL Operation is supported for custom components but is not supported for system components.