Skip to main content
POST
Configure payment reminders for a client
Authentication: API key OAuth 2.0
Scope: client_invoice.write
Related guide: Payment reminders
A client holds at most one reminder configuration. Calling this endpoint again for the same client replaces the existing one: send_to, copy_to_self and the entire rules array are overwritten, and the previous rules are discarded. Read the current configuration first if you only mean to change part of it.
Price plans: this endpoint requires the Invoice Automation add-on. Removing the add-on deletes the reminder configuration of every client in the organization, and it cannot be recovered — it has to be created again.
A 404 response means the reminder could not be read back for your organization after being written.

Authorizations

Authorization
string
header
required

Bearer authorization header: Bearer <token>, where <token> is the access token received from the authorization server at the end of the OAuth 2.0 flow.

Headers

X-Qonto-Staging-Token
string

Required only for Sandbox API requests; to get one, please sign up to the Developer Portal.

Body

application/json

offset_days is required when operator is before or after. Ignored when operator is on.

client_id
string<uuid>
required

The client the reminders are configured for.

Example:

"5c1f4e3a-9b7d-4a1e-8f2c-3d6b8a0e7f11"

send_to
string<email>[]
required

The email addresses the reminders are sent to.

Minimum array length: 1
Example:
rules
object[]
required

The reminder schedule. Between 1 and 5 rules, each anchored on the invoice due date.

Required array length: 1 - 5 elements
copy_to_self
boolean
default:false

Whether a copy of each reminder is also sent to your organization's contact email.

Response

Returns the reminder configuration created or replaced.

reminder
object
required