Skip to main content
POST
Send a payment reminder now

Authorizations

x-dolfin-api-key
string
header
required

An API key issued to your client. It carries the client's scope; org-scoped calls also require the x-dolfin-organisation-id header. Keys are created and revoked by a client administrator.

Headers

x-dolfin-organisation-id
string<uuid>

Target organisation. Required when authenticating with an API key; omit for Bearer callers (resolved from the token).

Path Parameters

invoiceId
string<uuid>
required

Body

application/json
subject
null | string
message
null | string

Response

OK

id
string<uuid>
invoiceId
string<uuid>
offset
null | enum<string>

The preset offset this reminder was auto-scheduled from, or null for ad-hoc reminders created via POST /invoices/{id}/reminders with an explicit scheduledAt.

Available options:
OneWeekBefore,
TwoDaysBefore,
OnDueDate,
TwoDaysAfter,
OneWeekAfter
scheduledAt
string<date-time>
status
enum<string>
Available options:
Pending,
Sent,
Cancelled,
Failed
subject
null | string
body
null | string
createdAt
string<date-time>
updatedAt
string<date-time>
sentAt
null | string<date-time>
cancelledAt
null | string<date-time>
failureReason
null | string