Update existing notification

Updates the settings of an existing notification by ID.

Use this operation to change the delivery channels individually, enable or disable the notification, or adjust when it is triggered for supported events. To change several notifications of the same customer in a single request, use Update existing notifications in batch.

A customer can have more than one notification for the same event. Use the id of the specific configuration returned by Retrieve notifications from a customer.

📘

Update behavior

If enabled is false, the notification will not be sent, even if some channel remains enabled.

Changes affect upcoming communications. Notifications that have already been sent are not recreated or automatically resent.

Related content

Guides

Path Params
string
required

Unique identifier of the notification to be updated

Body Params
boolean

Enable/disable notification

boolean

enable/disable the email sent to you

boolean

enable/disable the SMS sent to you

boolean

enable/disable the email sent to your customer

boolean

enable/disable the SMS sent to your customer

boolean

enable/disable voice notification sent to your customer

boolean

enable/disable WhatsApp messages for your customer

int32
enum

Specifies how many days before the due date the notification must be sent.
For the PAYMENT_DUEDATE_WARNING event, the accepted values are: 0, 5, 10, 15 and 30
For the PAYMENT_OVERDUE event, the accepted values are: 1, 7, 15 and 30

Allowed:
Responses

404

Not found

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json