API

Create a notification

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

Creates a notification informing a set of users about new invoices, credit memos, or debit 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.

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

Creation of invoice, credit memo, or debit memo notification.

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 4 months ago

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

Updated 4 months ago