Withdraws member consents
curl --request POST \
--url https://{host}/consent/v1/UserConsents/withdraw/bulk \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"consentIds": [
"<string>"
],
"userId": "<string>",
"revokedBy": "<string>",
"revocationSource": "\n WEB\n ",
"timestamp": "2023-11-07T05:31:56Z",
"metadata": {}
}
'import requests
url = "https://{host}/consent/v1/UserConsents/withdraw/bulk"
payload = {
"consentIds": ["<string>"],
"userId": "<string>",
"revokedBy": "<string>",
"revocationSource": "
WEB
",
"timestamp": "2023-11-07T05:31:56Z",
"metadata": {}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
consentIds: ['<string>'],
userId: '<string>',
revokedBy: '<string>',
revocationSource: '\n WEB\n ',
timestamp: '2023-11-07T05:31:56Z',
metadata: {}
})
};
fetch('https://{host}/consent/v1/UserConsents/withdraw/bulk', 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://{host}/consent/v1/UserConsents/withdraw/bulk",
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([
'consentIds' => [
'<string>'
],
'userId' => '<string>',
'revokedBy' => '<string>',
'revocationSource' => '
WEB
',
'timestamp' => '2023-11-07T05:31:56Z',
'metadata' => [
]
]),
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://{host}/consent/v1/UserConsents/withdraw/bulk"
payload := strings.NewReader("{\n \"consentIds\": [\n \"<string>\"\n ],\n \"userId\": \"<string>\",\n \"revokedBy\": \"<string>\",\n \"revocationSource\": \"\\n WEB\\n \",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", 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.post("https://{host}/consent/v1/UserConsents/withdraw/bulk")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"consentIds\": [\n \"<string>\"\n ],\n \"userId\": \"<string>\",\n \"revokedBy\": \"<string>\",\n \"revocationSource\": \"\\n WEB\\n \",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/consent/v1/UserConsents/withdraw/bulk")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"consentIds\": [\n \"<string>\"\n ],\n \"userId\": \"<string>\",\n \"revokedBy\": \"<string>\",\n \"revocationSource\": \"\\n WEB\\n \",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"message": "<string>",
"details": null
}Withdraws member consents
POST
/
v1
/
UserConsents
/
withdraw
/
bulk
Withdraws member consents
curl --request POST \
--url https://{host}/consent/v1/UserConsents/withdraw/bulk \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"consentIds": [
"<string>"
],
"userId": "<string>",
"revokedBy": "<string>",
"revocationSource": "\n WEB\n ",
"timestamp": "2023-11-07T05:31:56Z",
"metadata": {}
}
'import requests
url = "https://{host}/consent/v1/UserConsents/withdraw/bulk"
payload = {
"consentIds": ["<string>"],
"userId": "<string>",
"revokedBy": "<string>",
"revocationSource": "
WEB
",
"timestamp": "2023-11-07T05:31:56Z",
"metadata": {}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
consentIds: ['<string>'],
userId: '<string>',
revokedBy: '<string>',
revocationSource: '\n WEB\n ',
timestamp: '2023-11-07T05:31:56Z',
metadata: {}
})
};
fetch('https://{host}/consent/v1/UserConsents/withdraw/bulk', 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://{host}/consent/v1/UserConsents/withdraw/bulk",
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([
'consentIds' => [
'<string>'
],
'userId' => '<string>',
'revokedBy' => '<string>',
'revocationSource' => '
WEB
',
'timestamp' => '2023-11-07T05:31:56Z',
'metadata' => [
]
]),
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://{host}/consent/v1/UserConsents/withdraw/bulk"
payload := strings.NewReader("{\n \"consentIds\": [\n \"<string>\"\n ],\n \"userId\": \"<string>\",\n \"revokedBy\": \"<string>\",\n \"revocationSource\": \"\\n WEB\\n \",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", 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.post("https://{host}/consent/v1/UserConsents/withdraw/bulk")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"consentIds\": [\n \"<string>\"\n ],\n \"userId\": \"<string>\",\n \"revokedBy\": \"<string>\",\n \"revocationSource\": \"\\n WEB\\n \",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/consent/v1/UserConsents/withdraw/bulk")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"consentIds\": [\n \"<string>\"\n ],\n \"userId\": \"<string>\",\n \"revokedBy\": \"<string>\",\n \"revocationSource\": \"\\n WEB\\n \",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"message": "<string>",
"details": null
}Authorizations
Body
application/json
DTO, contains data for consent withdraw operations
Consent identifiers
User identifier
Minimum string length:
1When withdraw by user - user ID When withdraw by customer support worker - ID of customer support worker
Source of media used for revocation consent
Example:
"\n WEB\n "
Defines time when consent was revoked Used for data migration needs
Metadata for user consent
Show child attributes
Show child attributes
Response
Withdraw succeeded
Last modified on August 10, 2026
⌘I