Update a payment reminder configuration

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

1 { 2 "id": "id", 3 "created_at": "2024-01-15T09:30:00Z", 4 "updated_at": "2024-01-15T09:30:00Z", 5 "entity_id": "entity_id", 6 "name": "name", 7 "status": "active", 8 "recipients": { 9 "bcc": [ 10 "bcc" 11 ], 12 "cc": [ 13 "cc" 14 ], 15 "to": [ 16 "to" 17 ] 18 }, 19 "term_1_reminder": { 20 "body": "body", 21 "days_before": 1, 22 "subject": "subject" 23 }, 24 "term_2_reminder": { 25 "body": "body", 26 "days_before": 1, 27 "subject": "subject" 28 }, 29 "term_final_reminder": { 30 "body": "body", 31 "days_before": 1, 32 "subject": "subject" 33 } 34 }

Path parameters

payment_reminder_idstringRequired

Request

This endpoint expects an object.

namestringOptional>=1 character<=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: