Create a payment reminder configuration

curl -X POST https://api.sandbox.monite.com/v1/payment_reminders \
     -H "x-monite-version: 2024-05-25" \
     -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "name"
}'

{
  "id": "id",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "entity_id": "entity_id",
  "name": "name",
  "status": "active",
  "recipients": {
    "bcc": [
      "bcc"
    ],
    "cc": [
      "cc"
    ],
    "to": [
      "to"
    ]
  },
  "term_1_reminder": {
    "body": "body",
    "days_before": 1,
    "subject": "subject"
  },
  "term_2_reminder": {
    "body": "body",
    "days_before": 1,
    "subject": "subject"
  },
  "term_final_reminder": {
    "body": "body",
    "days_before": 1,
    "subject": "subject"
  }
}

Authentication

AuthorizationBearer

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

Headers

x-monite-versionstringRequired

x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.

namestringRequired1-255 characters

recipientsobjectOptional

term_1_reminderobjectOptional

Reminder to send for first payment term

term_2_reminderobjectOptional

Reminder to send for second payment term

term_final_reminderobjectOptional

Reminder to send for final payment term

Response

Successful Response

idstringformat: "uuid"

created_atdatetime

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

updated_atdatetime

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

entity_idstringformat: "uuid"

namestring

statusenum

Allowed values:

recipientsobject

term_1_reminderobject

Reminder to send for first payment term

term_2_reminderobject

Reminder to send for second payment term

term_final_reminderobject

Reminder to send for final payment term

Errors

400

Post Payment Reminders Request Bad Request Error

401

Post Payment Reminders Request Unauthorized Error

403

Post Payment Reminders Request Forbidden Error

422

Post Payment Reminders Request Unprocessable Entity Error

429

Post Payment Reminders Request Too Many Requests Error