Skip to main content
POST
/
overdue_reminders
Create an overdue reminder configuration
curl --request POST \
  --url https://api.sandbox.monite.com/v1/overdue_reminders \
  --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 '
{
  "name": "<string>",
  "recipients": {
    "bcc": [
      "jsmith@example.com"
    ],
    "cc": [
      "jsmith@example.com"
    ],
    "to": [
      "jsmith@example.com"
    ]
  },
  "terms": [
    {
      "body": "<string>",
      "days_after": 5000,
      "subject": "<string>"
    }
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "recipients": {
    "bcc": [
      "jsmith@example.com"
    ],
    "cc": [
      "jsmith@example.com"
    ],
    "to": [
      "jsmith@example.com"
    ]
  },
  "terms": [
    {
      "body": "<string>",
      "days_after": 5000,
      "subject": "<string>"
    }
  ]
}

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"

Body

application/json
name
string
required
Required string length: 1 - 255
recipients
object
terms
object[]

Overdue reminder terms to send for payment

Required array length: 1 - 3 elements

Response

Successful Response

id
string<uuid>
required
created_at
string<date-time>
required

Time at which the OverdueReminder was created. Timestamps follow the ISO 8601 standard.

updated_at
string<date-time>
required

Time at which the OverdueReminder was last updated. Timestamps follow the ISO 8601 standard.

name
string
required
recipients
object
terms
object[]

Overdue reminder terms to send for payment

Minimum array length: 1