Skip to main content
POST
/
receivables
/
{receivable_id}
/
send_test_reminder
Send a test reminder
curl --request POST \
  --url https://api.sandbox.monite.com/v1/receivables/{receivable_id}/send_test_reminder \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>' \
  --data '
{
  "reminder_type": "term_1",
  "recipients": {
    "bcc": [
      "jsmith@example.com"
    ],
    "cc": [
      "jsmith@example.com"
    ],
    "to": [
      "jsmith@example.com"
    ]
  }
}
'
{
  "mail_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-monite-version
string<date>
required
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Path Parameters

receivable_id
string<uuid>
required

ID of an existing invoice for which you want to send a payment reminder or overview reminder.

Body

application/json

Payload for sending a test reminder email

reminder_type
enum<string>
required

The type of the reminder to be sent.

Available options:
term_1,
term_2,
term_final,
overdue
recipients
object

Response

Successful Response

A schema for returning a response with list of ids by which user check sending status

mail_ids
string<uuid>[]
required