Send a test reminder

POST

Path parameters

receivable_idstringRequired

Headers

Auth
AuthorizationstringRequired
Bearer authentication of the form Bearer <token>, where token is your auth token.
x-monite-versionstringRequired
x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.
reminder_typeenumRequired
Allowed values: term_1term_2term_finaloverdue

The type of the reminder to be sent.

recipientsobjectOptional

Response

This endpoint returns an object.
mail_idslist of strings

Errors