cURL
curl --request POST \
--url https://api.example.com/v1/account/preferences/unsubscribe \
--header 'X-CSRF-Token: <x-csrf-token>'import requests
url = "https://api.example.com/v1/account/preferences/unsubscribe"
headers = {"X-CSRF-Token": "<x-csrf-token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-CSRF-Token': '<x-csrf-token>'}};
fetch('https://api.example.com/v1/account/preferences/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://api.example.com/v1/account/preferences/unsubscribe",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"X-CSRF-Token: <x-csrf-token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/account/preferences/unsubscribe"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-CSRF-Token", "<x-csrf-token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/account/preferences/unsubscribe")
.header("X-CSRF-Token", "<x-csrf-token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/account/preferences/unsubscribe")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-CSRF-Token"] = '<x-csrf-token>'
response = http.request(request)
puts response.read_body{
"locale": "auto",
"notifications": {
"expiry": true,
"traffic": true,
"renewal": true,
"news": true
},
"marketing": {
"enabled": true,
"decidedAt": "2023-11-07T05:31:56Z",
"source": "<string>",
"policyVersion": "<string>"
},
"contacts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "email",
"verified": true,
"transactional": true,
"marketing": true,
"createdAt": "2023-11-07T05:31:56Z"
}
],
"quietHours": {
"startHour": 11,
"endHour": 11
},
"suppression": {
"reason": "customer_request",
"createdAt": "2023-11-07T05:31:56Z"
}
}account
Post v1accountpreferencesunsubscribe
Stops marketing messages. Transactional messages about a payment, an expiry, or a support reply continue, because they are the ones a customer needs in order to keep using what they bought.
POST
/
v1
/
account
/
preferences
/
unsubscribe
cURL
curl --request POST \
--url https://api.example.com/v1/account/preferences/unsubscribe \
--header 'X-CSRF-Token: <x-csrf-token>'import requests
url = "https://api.example.com/v1/account/preferences/unsubscribe"
headers = {"X-CSRF-Token": "<x-csrf-token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-CSRF-Token': '<x-csrf-token>'}};
fetch('https://api.example.com/v1/account/preferences/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://api.example.com/v1/account/preferences/unsubscribe",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"X-CSRF-Token: <x-csrf-token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/account/preferences/unsubscribe"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-CSRF-Token", "<x-csrf-token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/account/preferences/unsubscribe")
.header("X-CSRF-Token", "<x-csrf-token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/account/preferences/unsubscribe")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-CSRF-Token"] = '<x-csrf-token>'
response = http.request(request)
puts response.read_body{
"locale": "auto",
"notifications": {
"expiry": true,
"traffic": true,
"renewal": true,
"news": true
},
"marketing": {
"enabled": true,
"decidedAt": "2023-11-07T05:31:56Z",
"source": "<string>",
"policyVersion": "<string>"
},
"contacts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "email",
"verified": true,
"transactional": true,
"marketing": true,
"createdAt": "2023-11-07T05:31:56Z"
}
],
"quietHours": {
"startHour": 11,
"endHour": 11
},
"suppression": {
"reason": "customer_request",
"createdAt": "2023-11-07T05:31:56Z"
}
}Headers
Echoes the token from the current session. Required on every unsafe method.
Response
200 - application/json
Unsubscribed
Available options:
auto, ru, en Show child attributes
Show child attributes
Show child attributes
Show child attributes
Flags only. The address itself is never returned.
Show child attributes
Show child attributes
Absent when unset.
Show child attributes
Show child attributes
Show child attributes
Show child attributes