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": "care@yourdomain.com",
  "email": "joe@blogs.com",
  "orderIds": "[9382721,282262]",
  "subscriberIds": "[123455,123456]",
  "sendUserCommunication": false
}
'
import requests

url = "https://test.paysight.io/customerapi/unsubscribe"

payload = {
    "parentCompanyId": 1,
    "userEmail": "care@yourdomain.com",
    "email": "joe@blogs.com",
    "orderIds": "[9382721,282262]",
    "subscriberIds": "[123455,123456]",
    "sendUserCommunication": False
}
headers = {
    "ClientId": "<clientid>",
    "UserEmail": "<useremail>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {
    ClientId: '<clientid>',
    UserEmail: '<useremail>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    parentCompanyId: 1,
    userEmail: 'care@yourdomain.com',
    email: 'joe@blogs.com',
    orderIds: '[9382721,282262]',
    subscriberIds: '[123455,123456]',
    sendUserCommunication: false
  })
};

fetch('https://test.paysight.io/customerapi/unsubscribe', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://test.paysight.io/customerapi/unsubscribe",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'parentCompanyId' => 1,
    'userEmail' => 'care@yourdomain.com',
    'email' => 'joe@blogs.com',
    'orderIds' => '[9382721,282262]',
    'subscriberIds' => '[123455,123456]',
    'sendUserCommunication' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "ClientId: <clientid>",
    "Content-Type: application/json",
    "UserEmail: <useremail>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://test.paysight.io/customerapi/unsubscribe"

	payload := strings.NewReader("{\n  \"parentCompanyId\": 1,\n  \"userEmail\": \"care@yourdomain.com\",\n  \"email\": \"joe@blogs.com\",\n  \"orderIds\": \"[9382721,282262]\",\n  \"subscriberIds\": \"[123455,123456]\",\n  \"sendUserCommunication\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("ClientId", "<clientid>")
	req.Header.Add("UserEmail", "<useremail>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://test.paysight.io/customerapi/unsubscribe")
  .header("ClientId", "<clientid>")
  .header("UserEmail", "<useremail>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"parentCompanyId\": 1,\n  \"userEmail\": \"care@yourdomain.com\",\n  \"email\": \"joe@blogs.com\",\n  \"orderIds\": \"[9382721,282262]\",\n  \"subscriberIds\": \"[123455,123456]\",\n  \"sendUserCommunication\": false\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://test.paysight.io/customerapi/unsubscribe")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["ClientId"] = '<clientid>'
request["UserEmail"] = '<useremail>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"parentCompanyId\": 1,\n  \"userEmail\": \"care@yourdomain.com\",\n  \"email\": \"joe@blogs.com\",\n  \"orderIds\": \"[9382721,282262]\",\n  \"subscriberIds\": \"[123455,123456]\",\n  \"sendUserCommunication\": false\n}"

response = http.request(request)
puts response.read_body
{
  "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:

"care@yourdomain.com"

email
string<email>

The email address of the customer. This is required

Example:

"joe@blogs.com"

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:

""