Update User Preferences
Reset
API to reset user preference settings to default preference.
PATCH
/
v1
/
bulk
/
user
/
preference
/
reset
/
Reset
curl --request PATCH \
--url https://hub.suprsend.com/v1/bulk/user/preference/reset/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"distinct_ids": [
"id1",
"id2"
],
"reset_channel_preferences": true,
"reset_categories": true
}
'import requests
url = "https://hub.suprsend.com/v1/bulk/user/preference/reset/"
payload = {
"distinct_ids": ["id1", "id2"],
"reset_channel_preferences": True,
"reset_categories": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
distinct_ids: ['id1', 'id2'],
reset_channel_preferences: true,
reset_categories: true
})
};
fetch('https://hub.suprsend.com/v1/bulk/user/preference/reset/', 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://hub.suprsend.com/v1/bulk/user/preference/reset/",
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([
'distinct_ids' => [
'id1',
'id2'
],
'reset_channel_preferences' => true,
'reset_categories' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://hub.suprsend.com/v1/bulk/user/preference/reset/"
payload := strings.NewReader("{\n \"distinct_ids\": [\n \"id1\",\n \"id2\"\n ],\n \"reset_channel_preferences\": true,\n \"reset_categories\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://hub.suprsend.com/v1/bulk/user/preference/reset/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"distinct_ids\": [\n \"id1\",\n \"id2\"\n ],\n \"reset_channel_preferences\": true,\n \"reset_categories\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://hub.suprsend.com/v1/bulk/user/preference/reset/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"distinct_ids\": [\n \"id1\",\n \"id2\"\n ],\n \"reset_channel_preferences\": true,\n \"reset_categories\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"code": 404,
"message": "tenant '_tenant_id_' not found"
}Authorizations
Pass as Bearer <API_KEY>. Get API Key from SuprSend dashboard Developers -> API Keys section.
Query Parameters
to fetch user preferences for a particular tenant
Body
application/json
distinct_id of users whose preference needs to be reset
setting this to true will set all channel preference to default setting.
setting this to true will set all category preferences to default tenant preference.
Response
202
Example:
true
Was this page helpful?
Previous
Get Tenant Full PreferenceAPI to fetch tenant preferences across all categories with translated names and descriptions.
Next
⌘I
Reset
curl --request PATCH \
--url https://hub.suprsend.com/v1/bulk/user/preference/reset/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"distinct_ids": [
"id1",
"id2"
],
"reset_channel_preferences": true,
"reset_categories": true
}
'import requests
url = "https://hub.suprsend.com/v1/bulk/user/preference/reset/"
payload = {
"distinct_ids": ["id1", "id2"],
"reset_channel_preferences": True,
"reset_categories": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
distinct_ids: ['id1', 'id2'],
reset_channel_preferences: true,
reset_categories: true
})
};
fetch('https://hub.suprsend.com/v1/bulk/user/preference/reset/', 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://hub.suprsend.com/v1/bulk/user/preference/reset/",
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([
'distinct_ids' => [
'id1',
'id2'
],
'reset_channel_preferences' => true,
'reset_categories' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://hub.suprsend.com/v1/bulk/user/preference/reset/"
payload := strings.NewReader("{\n \"distinct_ids\": [\n \"id1\",\n \"id2\"\n ],\n \"reset_channel_preferences\": true,\n \"reset_categories\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://hub.suprsend.com/v1/bulk/user/preference/reset/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"distinct_ids\": [\n \"id1\",\n \"id2\"\n ],\n \"reset_channel_preferences\": true,\n \"reset_categories\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://hub.suprsend.com/v1/bulk/user/preference/reset/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"distinct_ids\": [\n \"id1\",\n \"id2\"\n ],\n \"reset_channel_preferences\": true,\n \"reset_categories\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"code": 404,
"message": "tenant '_tenant_id_' not found"
}