---
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

---

[API](https://skmtc.net/velopaymentsapi/apis/velo-payments-apis.md) · [All operations](https://skmtc.net/velopaymentsapi/apis/velo-payments-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/velopaymentsapi/velo-payments-apis/revisions/05c3f09fc50a/schema)