POST
/
unsubscribe
Unsubscribe
curl --request POST \
  --url https://test.paysight.io/customerapi/unsubscribe \
  --header 'ClientId: <clientid>' \
  --header 'Content-Type: application/json' \
  --header 'UserEmail: <useremail>' \
  --data '{
  "parentCompanyId": 1,
  "userEmail": "care@yourdomain.com",
  "email": "joe@blogs.com",
  "orderIds": "[9382721,282262]",
  "subscriberIds": "[123455,123456]",
  "sendUserCommunication": false
}'
{
  "success": true,
  "message": "",
  "unsubscribes": 1
}

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

Payload

The body is of type object.

Response

200 - application/json

Valid Request. More detailed info will be in the JSON body

The response is of type object.