Reminder Email Opt-Out

v1.0.0

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.

Input

{
  "type": "object",
  "properties": {
    "payorId": {
      "type": "string",
      "format": "uuid"
    },
    "reminderEmailsOptOut": {
      "type": "boolean"
    }
  },
  "required": [
    "payorId",
    "reminderEmailsOptOut"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "additionalProperties": true
}