Update a notification definition

Updates a notification definition.

Request
path Parameters
id
required
string <uuid>

The ID of the notification definition to be updated.

header Parameters
Accept-Encoding
string

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.

Content-Encoding
string

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.

Authorization
required
string

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

Zuora-Track-Id
string <= 64 characters

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 (').

Zuora-Entity-Ids
string

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 should not set this header.

Zuora-Org-Ids
string

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.

Request Body schema: application/json
required

The request body of the notification definition to be updated.

active
boolean
Default: true

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

associatedAccount
string

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.

Callout - without authentication (object) or Callout - Base authentication (object) or Callout - OAuth 2.0 authentication (object)

If this field is specified, Zuora will create a new callout template when creating the notification definition and associate the template with the notification definition.

You cannot specify the calloutTemplateIds and callout fields at the same time.

For more information about callout templates, see Manage callout templates.

calloutActive
boolean
Default: false

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

calloutTemplateIds
Array of strings

List of callout template IDs that the notification definition is associated with.

You cannot specify the calloutTemplateIds and callout fields at the same time.

For more information about callout templates, see Manage callout templates.

communicationProfileId
string <uuid>

The profile that notification definition belongs to.

If you want to associate the notification definition with multiple communication profiles, use the communicationProfileIds field, which overrides this field.

communicationProfileIds
Array of strings

List of communication profile IDs that the notification definition is associated with.

This field overrides the communicationProfileId field.

description
string <= 255 characters

The description of the notification definition.

emailActive
boolean
Default: false

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

emailTemplateId
string <uuid>

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.

object
object (filterRuleParams)

The parameter values used to configure the filter rule.

name
string <= 255 characters

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

Responses
200

OK

400

Bad Request

404

Not Found

405

Method Not Allowed

415

Unsupported Media Type

500

Internal Server Error

put/notifications/notification-definitions/{id}
Request samples
application/json
{
  • "active": true,
  • "callout": {
    },
  • "calloutActive": true,
  • "communicationProfileId": "6e569e1e05f040eda51a927b140c0ac5",
  • "description": "Notification sent out when an account is edited",
  • "emailActive": true,
  • "emailTemplateId": "6e569e1e05f040eda51a927b140c0ac6",
  • "filterRule": {
    },
  • "filterRuleParams": {
    },
  • "name": "Account Edit Notification"
}
Response samples
application/json
{
  • "active": true,
  • "associatedAccount": "ParentAccount.Id",
  • "callout": {
    },
  • "calloutActive": true,
  • "calloutTemplateIds": [
    ],
  • "communicationProfileId": "6e569e1e05f040eda51a927b140c0ac5",
  • "communicationProfileIds": [
    ],
  • "createdBy": "6e569e1e05f040eda51a927b140c0ac3",
  • "createdOn": "2017-04-18T07:36:19.798Z",
  • "description": "Notification sent out when an account is edited",
  • "emailActive": true,
  • "emailTemplateId": "6e569e1e05f040eda51a927b140c0ac6",
  • "eventTypeName": "AccountEdit",
  • "filterRule": {
    },
  • "filterRuleParams": {
    },
  • "id": "6e569e1e05f040eda51a927b140c0ac2",
  • "name": "Account Edit Notification",
  • "updatedBy": "6e569e1e05f040eda51a927b140c0ac4",
  • "updatedOn": "2017-04-18T07:36:19.798Z"
}