Skip to main content
POST
/
api
/
mitigation
/
unsubscribe
Unsubscribe a user
curl --request POST \
  --url https://test.paysight.io/api/mitigation/unsubscribe \
  --header 'Authorization: <api-key>' \
  --header 'ClientId: <clientid>' \
  --header 'Content-Type: application/json' \
  --header 'UserEmail: <useremail>' \
  --data '{
  "email": "joe@blogs.com",
  "orderIds": [
    123
  ],
  "subscriberIds": [
    123
  ]
}'
{
  "success": true,
  "message": "<string>",
  "unsubscribes": 123
}

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