v1

latestOpenAPI 3.0.2Apache License 2.02026-07-13109285691.8 KB
Payors

Reminder Email Opt-Out

Update the emailRemindersOptOut field for a Payor. This API can be used to opt out or opt into Payor Reminder emails. These emails are typically around payee events such as payees registering and onboarding.

post/v1/payors/{payorId}/reminderEmailsUpdate

Path parameters

payorIdstring uuid required

The account owner Payor ID

Request body

reminderEmailsOptOutboolean required

Example request

{
  "reminderEmailsOptOut": true
}

Response

HTTP Accepted