Update a notification definition

Learn how to update a notification definition by the Settings API.

To update a specific notification definition, ID of the notification definition is required as a path parameter. See the following sample request and 200 response body.

This operation applies to notification definitions for standard, custom, and custom scheduled events.

HTTP request:

PUT https://rest.zuora.com/settings/communication-profiles/notifications/{id}

Request body:

{
    "id": "8ad08cbd85ed98570185f6e540e46b90",
    "profileId": "8ad099158499bf1101849deab4025e2b",
    "eventId": "1d3d0e5b2b8b11e5b8640025904cb7f0",
    "eventName": "Invoice Due",
    "name": "20 Days Past Invoice Due",
    "description": "The invoice is 20 days past due.",
    "active": true,
    "hidden": false,
    "param1": "20",
    "param2": "Days_after_Invoice_Due_Date",
    "param4": "Not include invoice PDF",
    "emailOption": true,
    "emailTemplate": "2c92c0f85e0d9c58015e0e9376423740",
    "emailTemplateName": "Invoice Due Email Template",
    "calloutOption": false,
    "calloutBaseUrl": "https://test.com",
    "contentType": "APPLICATION_JSON",
    "httpMethod": "POST",
    "calloutRetriable": false,
    "calloutAuth": false,
    "calloutOauth2": false,
    "calloutPreemptiveAuth": false,
    "calloutParams": "{}"
}

Response body:

{
    "id": "8ad08cbd85ed98570185f6e540e46b90",
    "profileId": "8ad099158499bf1101849deab4025e2b",
    "eventId": "1d3d0e5b2b8b11e5b8640025904cb7f0",
    "eventName": "Invoice Due",
    "name": "20 Days Past Invoice Due",
    "description": "The invoice is 20 days past due.",
    "active": true,
    "hidden": false,
    "param1": "20",
    "param2": "Days_after_Invoice_Due_Date",
    "param4": "Not include invoice PDF",
    "emailOption": true,
    "emailTemplate": "2c92c0f85e0d9c58015e0e9376423740",
    "emailTemplateName": "Invoice Due Email Template",
    "calloutOption": false,
    "calloutBaseUrl": "https://test.com",
    "contentType": "APPLICATION_JSON",
    "httpMethod": "POST",
    "calloutRetriable": false,
    "calloutAuth": false,
    "calloutOauth2": false,
    "calloutPreemptiveAuth": false,
    "useCustomRequestBody": false,
    "customRequestBody": "",
    "associatedAccount": "",
    "calloutParams": "{}"
}