Create a notification
POST https://{{host}}/invoicing-api/v3/notifications
Creates a notification informing a set of users about new invoices or credit memos for a set of contracts. Each notification needs to specify a unique set of contracts. The request yields an error if the set of contractId values matches that of another notification.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
accountSwitchKey | string | (Optional) 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. |
Request Body
{"contracts"=>["1-ABCDEF"], "emails"=>["user@example.com"], "notificationStatus"=>"ACTIVE", "notificationTitle"=>"Notification for 1-ABCDEF"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"contracts":["1-ABCDEF"],"creationDate":"2020-12-09T08:30:14Z","emails":["user@example.com"],"modificationDate":"2020-12-09T08:30:14Z","notificationId":25056,"notificationStatus":"ACTIVE","notificationTitle":"Notification for 1-ABCDEF"}