---
title: "Reminder Email Opt-Out"
method: POST
path: "/v1/payors/{payorId}/reminderEmailsUpdate"
tags: ["Payors"]
---

# Reminder Email Opt-Out

`POST /v1/payors/{payorId}/reminderEmailsUpdate`

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.

## Path parameters

- `payorId` string, uuid, required

## Request body

- PayorEmailOptOutRequest
  - `reminderEmailsOptOut` boolean, required

## Response `202`

HTTP Accepted

## Other responses

- `400` — Invalid request. See Error message payload for details of failure
- `403` — The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions
- `404` — Payor Id Not Found

## Changes

- **2020-09-25** `dd71433847a6` — 2 breaking, 18 info
  - the `errors/items/` response's property type changed from no type to `object` for status `400`
  - the `errors/items/` response's property type changed from no type to `object` for status `403`
  - added the optional property `errors/items/errorCode` to the response with the `400` status
  - added the optional property `errors/items/errorCode` to the response with the `403` status
  - …16 more
- **2020-01-28** `1b2abf26b5d6` — 4 breaking, 3 warning
  - the response's body type changed from `object` to no type for status `400`
  - the response's body type changed from `object` to no type for status `403`
  - the `errors/items/` response's property type changed from `object` to no type for status `400`
  - the `errors/items/` response's property type changed from `object` to no type for status `403`
  - …3 more
- **2019-12-11** `a0b19fa311c0` — 3 info
  - added the media type `application/json` for the response with the status `400`
  - added the media type `application/json` for the response with the status `404`
  - added the non-success response with the status `403`
- **2019-07-15** `ced8e167a97c` — 2 breaking, 1 info
  - removed the media type `application/json` for the response with the status `400`
  - removed the media type `application/json` for the response with the status `404`
  - removed the non-success response with the status `403`

[Change history](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/changes/v1/payors/:payorId/reminderEmailsUpdate/post.md)

---

[API](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis.md) · [All operations](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/llms.txt) · [OpenAPI document](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/revisions/25a3d8f6e24a?raw)