PUT /notifications/notification-definitions/{id}

The ID of the notification definition to be updated.

Default value: "application/json"

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

The parameter values used to configure the filter rule.

The name of the notification definition, which is unique in the profile.

The status of the notification definition. The default value is true.

Default value: true

The status of the callout action. The default value is false.

Default value: false

The profile that notification definition belongs to. If you want to update the notification to a system notification, you should pass 'SystemNotification'. '

The description of the notification definition.

The description of the filter rule.

The parameters of the filter rule and their name must match those in the filter rule. And all parameters must be defined in the event type payload. The name of parameters can't be duplicate. The following reserved keywords should not be used as a parameter name: AttachmentList, RecipientList, RecipientType, Exceptions, OCP_OBJECT_TYPE, OCP_OBJECT_ID, OCP_TRIGGER_BY

Definition of a filter rule parameter.

The option values of the parameter.

The display name of the parameter.

The type of the value.

Possible values:

• "CHARACTER_ARRAY"
• "STRING"
• "BOOLEAN_ARRAY"
• "LOCAL_DATE_TIME"
• "INTEGER"
• "LOCAL_DATE"
• "TIMESTAMP_ARRAY"
• "FLOAT"
• "LOCAL_DATE_ARRAY"
• "LONG"
• "CHARACTER"
• "INTEGER_ARRAY"
• "FLOAT_ARRAY"
• "SHORT_ARRAY"
• "DOUBLE"
• "BYTE"
• "BIG_INTEGER"
• "TIMESTAMP"
• "STRING_ARRAY"
• "BIG_DECIMAL_ARRAY"
• "DOUBLE_ARRAY"
• "BOOLEAN"
• "LOCAL_DATE_TIME_ARRAY"
• "BIG_INTEGER_ARRAY"
• "SHORT"
• "BIG_DECIMAL"
• "BYTE_ARRAY"

The filter rule conditions, written in JEXL. The rule might contain event context merge fields and data source merge fields. Data source merge fields must be from the base object of the event or from the joined objects of the base object. Notifications with invalid merge fields will fail to evaluate, thus will not be invoked. For example, to trigger an event when an invoice is posted with the amount over 1000, you would define the following condition on the Invoice object:

changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000

There are conventions and keywords you need to be aware of. For example:

• changeType is a keyword to specify what kind of change happened to the object. Allowed values are INSERT, UPDATE or DELETE.

• Invoice.Status refers to field Status of the Zuora object Invoice.

• A variable with the _old suffix means it’s a previous value of the corresponding object field. The "_old" fields are only available on the base objects.

The status of the email action. The default value is false.

Default value: false

The account on which the histories of this notification will be displayed. The associated account does not enforce where the merge fields come from. Available values are as follows:

• Account.Id: ID of the primary customer account related to the notification. It is also the default value.
• ParentAccount.Id: this option is available only if you have Customer Hierarchy enabled for your tenant.
• SubscriptionOwnerAccount.Id: this option is available if the base object of the notification is Order Action.

Note: before specifying this field, we recommend that you use Data Source to check the available types of accounts for the current notification.

The ID of the email template. If emailActive is updated from false to true, an email template is required, and the EventType of the email template MUST be the same as the EventType of the notification definition.