Skip to main content
POST
Unsubscribe a user

Authorizations

Authorization
string
header
required

Your Paysight API key

Headers

ClientId
string
required

Your Paysight Tenant/Client Id. This is the id of the parent company listed in https://app.paysight.io/management/companies. Alternatively, this will be provided by Paysight

UserEmail
string
required

The email address of the party or group making the request

Body

application/json

Request body to unsubscribe a customer

email
string
required

Email of the customer to unsubscribe

Example:

"joe@blogs.com"

orderIds
integer[]

Optional list of order IDs to match against

subscriberIds
integer[]

Optional list of subscriber IDs to directly target

Response

200 - application/json

Result of unsubscribe request

success
boolean
message
string
unsubscribes
integer