Skip to main content
PUT
Replace a payment reminder configuration
Authentication: API key OAuth 2.0
Scope: client_invoice.write
Related guide: Payment reminders
This replaces the entire rules array, not just the rules included in the request. Any rule not present in the payload is removed, and rule ids are not preserved across an update. Read the current configuration first if you only mean to change part of the schedule.
Price plans: this endpoint requires the Invoice Automation add-on. Without it, requests return 403. 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.

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.

Path Parameters

id
string<uuid>
required

The reminder's id.

Body

application/json

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

send_to
string<email>[]
required

The email addresses the reminders are sent to.

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

The complete reminder schedule. Replaces the existing schedule entirely — see the warning above.

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 updated reminder configuration.

reminder
object
required