Skip to main content
POST
/
v1
/
invoices
/
{id}
/
reminders
Send invoice reminder
curl --request POST \
  --url https://api.quentli.com/v1/invoices/{id}/reminders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": {
    "channel": "WHATSAPP"
  }
}
'
{
  "paymentReminder": {
    "id": "rem_1234567890abcdefghij",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "invoiceId": "inv_1234567890abcdefghij",
    "scheduledAt": null,
    "authLinkId": null,
    "type": "DUE",
    "outboundMessageId": null,
    "messageId": null,
    "sentById": null
  }
}

Authorizations

Authorization
string
header
required

Organization API key using Authorization: Bearer sk_....

Path Parameters

id
string
required

Identifier of the invoice.

Body

application/json

Request body for sending a payment reminder (invoice id is provided in the URL path).

input
object
required

Response

Invoice reminder sent

Response after sending a payment reminder.

paymentReminder
object
required

Payment reminder sent for an invoice.