API
Start typing to search…

Modify a notification

put
https://{hostname}/invoicing-api/v4/notifications/

Updates a notification. Any read-only members retained from a GET operation are ignored on subsequent PUTs.

Path Params
integer
required

Identifies the notification.

Query Params
string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params
contracts
array of strings
required
length ≥ 1

The contracts for which the notification applies.

contracts*
emails
array of strings
required
length ≥ 1

The recipients' email addresses.

emails*
string
enum
required

Either ACTIVE to notify recipients about changes to invoices, or SUSPENDED to disable a notification.

Allowed:
string
required
length ≥ 1

The title of the notification.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 1 month ago

Language
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json
Updated about 1 month ago