Withdraws user consent
curl --request POST \
--url https://{host}/consent/v1/UserConsents/withdraw \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"consentId": "<string>",
"userId": "<string>",
"revokedBy": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"revocationSource": "<string>",
"metadata": {}
}
'import requests
url = "https://{host}/consent/v1/UserConsents/withdraw"
payload = {
"consentId": "<string>",
"userId": "<string>",
"revokedBy": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"revocationSource": "<string>",
"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({
consentId: '<string>',
userId: '<string>',
revokedBy: '<string>',
timestamp: '2023-11-07T05:31:56Z',
revocationSource: '<string>',
metadata: {}
})
};
fetch('https://{host}/consent/v1/UserConsents/withdraw', 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",
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([
'consentId' => '<string>',
'userId' => '<string>',
'revokedBy' => '<string>',
'timestamp' => '2023-11-07T05:31:56Z',
'revocationSource' => '<string>',
'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"
payload := strings.NewReader("{\n \"consentId\": \"<string>\",\n \"userId\": \"<string>\",\n \"revokedBy\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"revocationSource\": \"<string>\",\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")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"consentId\": \"<string>\",\n \"userId\": \"<string>\",\n \"revokedBy\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"revocationSource\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/consent/v1/UserConsents/withdraw")
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 \"consentId\": \"<string>\",\n \"userId\": \"<string>\",\n \"revokedBy\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"revocationSource\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"message": "<string>",
"details": null
}Withdraws user consent
Withdraws user consent
POST
/
v1
/
UserConsents
/
withdraw
Withdraws user consent
curl --request POST \
--url https://{host}/consent/v1/UserConsents/withdraw \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"consentId": "<string>",
"userId": "<string>",
"revokedBy": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"revocationSource": "<string>",
"metadata": {}
}
'import requests
url = "https://{host}/consent/v1/UserConsents/withdraw"
payload = {
"consentId": "<string>",
"userId": "<string>",
"revokedBy": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"revocationSource": "<string>",
"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({
consentId: '<string>',
userId: '<string>',
revokedBy: '<string>',
timestamp: '2023-11-07T05:31:56Z',
revocationSource: '<string>',
metadata: {}
})
};
fetch('https://{host}/consent/v1/UserConsents/withdraw', 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",
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([
'consentId' => '<string>',
'userId' => '<string>',
'revokedBy' => '<string>',
'timestamp' => '2023-11-07T05:31:56Z',
'revocationSource' => '<string>',
'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"
payload := strings.NewReader("{\n \"consentId\": \"<string>\",\n \"userId\": \"<string>\",\n \"revokedBy\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"revocationSource\": \"<string>\",\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")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"consentId\": \"<string>\",\n \"userId\": \"<string>\",\n \"revokedBy\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"revocationSource\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/consent/v1/UserConsents/withdraw")
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 \"consentId\": \"<string>\",\n \"userId\": \"<string>\",\n \"revokedBy\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"revocationSource\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"message": "<string>",
"details": null
}Authorizations
Body
application/json
DTO for withdrawing a user consent
Consent identifier
Minimum string length:
1User identifier
Minimum string length:
1When revoked by user - user ID When revoked by customer support worker - ID of customer support worker
Defines time when consent was revoked Used for data migration needs
The source which triggered revocation of UserConsent
Metadata for user consent
Show child attributes
Show child attributes
Response
Withdrawn succeeded
Last modified on August 10, 2026
⌘I