Update recipient subscription
curl --request PATCH \
--url https://campaigns.sightx.io/campaigns-service/v1/recipients/updateRecipientsSubscription \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"recipientsIds": [
"recipient id 1",
"recipient id 2"
],
"subscribe": false,
"userId": "user id"
}
'import requests
url = "https://campaigns.sightx.io/campaigns-service/v1/recipients/updateRecipientsSubscription"
payload = {
"recipientsIds": ["recipient id 1", "recipient id 2"],
"subscribe": False,
"userId": "user id"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
recipientsIds: ['recipient id 1', 'recipient id 2'],
subscribe: false,
userId: 'user id'
})
};
fetch('https://campaigns.sightx.io/campaigns-service/v1/recipients/updateRecipientsSubscription', 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://campaigns.sightx.io/campaigns-service/v1/recipients/updateRecipientsSubscription",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'recipientsIds' => [
'recipient id 1',
'recipient id 2'
],
'subscribe' => false,
'userId' => 'user id'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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://campaigns.sightx.io/campaigns-service/v1/recipients/updateRecipientsSubscription"
payload := strings.NewReader("{\n \"recipientsIds\": [\n \"recipient id 1\",\n \"recipient id 2\"\n ],\n \"subscribe\": false,\n \"userId\": \"user id\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://campaigns.sightx.io/campaigns-service/v1/recipients/updateRecipientsSubscription")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"recipientsIds\": [\n \"recipient id 1\",\n \"recipient id 2\"\n ],\n \"subscribe\": false,\n \"userId\": \"user id\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://campaigns.sightx.io/campaigns-service/v1/recipients/updateRecipientsSubscription")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"recipientsIds\": [\n \"recipient id 1\",\n \"recipient id 2\"\n ],\n \"subscribe\": false,\n \"userId\": \"user id\"\n}"
response = http.request(request)
puts response.read_bodyAudiences/Recipient lists / Recipient lists
Update recipient subscription
Description
Update a recipient where recipientId is the id of the recipient to be updated.
Body
{
"recipientsIds": array,
"subscribe": boolean,
"userId": string
}
where:
recipientsIds: Array of recipients id to be updated.subscribe: Whether the recipients will be subscribed or unsubscribed.userId: User id of the user making the update.
Response
No response with 204 status code.
PATCH
/
campaigns-service
/
v1
/
recipients
/
updateRecipientsSubscription
Update recipient subscription
curl --request PATCH \
--url https://campaigns.sightx.io/campaigns-service/v1/recipients/updateRecipientsSubscription \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"recipientsIds": [
"recipient id 1",
"recipient id 2"
],
"subscribe": false,
"userId": "user id"
}
'import requests
url = "https://campaigns.sightx.io/campaigns-service/v1/recipients/updateRecipientsSubscription"
payload = {
"recipientsIds": ["recipient id 1", "recipient id 2"],
"subscribe": False,
"userId": "user id"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
recipientsIds: ['recipient id 1', 'recipient id 2'],
subscribe: false,
userId: 'user id'
})
};
fetch('https://campaigns.sightx.io/campaigns-service/v1/recipients/updateRecipientsSubscription', 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://campaigns.sightx.io/campaigns-service/v1/recipients/updateRecipientsSubscription",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'recipientsIds' => [
'recipient id 1',
'recipient id 2'
],
'subscribe' => false,
'userId' => 'user id'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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://campaigns.sightx.io/campaigns-service/v1/recipients/updateRecipientsSubscription"
payload := strings.NewReader("{\n \"recipientsIds\": [\n \"recipient id 1\",\n \"recipient id 2\"\n ],\n \"subscribe\": false,\n \"userId\": \"user id\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://campaigns.sightx.io/campaigns-service/v1/recipients/updateRecipientsSubscription")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"recipientsIds\": [\n \"recipient id 1\",\n \"recipient id 2\"\n ],\n \"subscribe\": false,\n \"userId\": \"user id\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://campaigns.sightx.io/campaigns-service/v1/recipients/updateRecipientsSubscription")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"recipientsIds\": [\n \"recipient id 1\",\n \"recipient id 2\"\n ],\n \"subscribe\": false,\n \"userId\": \"user id\"\n}"
response = http.request(request)
puts response.read_bodyDescription
Update a recipient whererecipientId is the id of the recipient to be updated.
Body
{
"recipientsIds": array,
"subscribe": boolean,
"userId": string
}
recipientsIds: Array of recipients id to be updated.subscribe: Whether the recipients will be subscribed or unsubscribed.userId: User id of the user making the update.
Response
No response with 204 status code.Was this page helpful?
⌘I