Skip to main content
POST
/
unsubscribe
Unsubscribe
curl --request POST \
  --url https://test.paysight.io/customerapi/unsubscribe \
  --header 'Authorization: <api-key>' \
  --header 'ClientId: <clientid>' \
  --header 'Content-Type: application/json' \
  --header 'UserEmail: <useremail>' \
  --data '
{
  "parentCompanyId": 1,
  "userEmail": "[email protected]",
  "email": "[email protected]",
  "orderIds": "[9382721,282262]",
  "subscriberIds": "[123455,123456]",
  "sendUserCommunication": false
}
'
{
  "success": true,
  "unsubscribes": 1,
  "message": ""
}

Authorizations

​
Authorization
string
header
required

Your Paysight API key. You can find it in your Paysight account at https://app.paysight.io/settings/account

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

​
parentCompanyId
integer
required

Your Paysight tenant id. This will be provided by Paysight.

Example:

1

​
userEmail
string<email>
required

An email associated with the party/agent making the request

Example:

"[email protected]"

​
email
string<email>

The email address of the customer. This is required

Example:

"[email protected]"

​
orderIds
integer[]

The related orderId or orderIds that initiated the user subscription or subscriptions

Example:

"[9382721,282262]"

​
subscriberIds
integer[]

The specific identifer for the user subscription(s)

Example:

"[123455,123456]"

​
sendUserCommunication
boolean

If true, then Paysight will send a confirmation to the user's email address (if mail settings are set up)

Example:

false

Response

200 - application/json

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

​
success
boolean
required

Indicates if user was successfully unsubscribed

Example:

true

​
unsubscribes
integer
required

Number of successful unsubscribes

Example:

1

​
message
string

Debug information

Example:

""