Reminder Email Opt-Out

Velo Payments Sandbox for testing

https://api.sandbox.velopayments.com/

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.

Request

Path Params

Body Params application/json

Examples

Responses

🟢202HTTP Accepted

application/json

Body

🟠400Invalid request. See Error message payload for details of failure

🟠403The 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

🟠404Payor Id Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.sandbox.velopayments.com//v1/payors//reminderEmailsUpdate' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reminderEmailsOptOut": true
}'

Response Example

202 - Example 1

{}

Modified at 2022-09-11 21:50:18

Add Logo

Get Payor