Request erasure of a contact (GDPR Art. 17)
curl --request POST \
--url https://api.nateq.io/api/v1/contacts/{id}/erasure-request \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"confirmIdentifier": "<string>",
"reason": "<string>"
}
'import requests
url = "https://api.nateq.io/api/v1/contacts/{id}/erasure-request"
payload = {
"confirmIdentifier": "<string>",
"reason": "<string>"
}
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({confirmIdentifier: '<string>', reason: '<string>'})
};
fetch('https://api.nateq.io/api/v1/contacts/{id}/erasure-request', 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.nateq.io/api/v1/contacts/{id}/erasure-request",
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([
'confirmIdentifier' => '<string>',
'reason' => '<string>'
]),
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://api.nateq.io/api/v1/contacts/{id}/erasure-request"
payload := strings.NewReader("{\n \"confirmIdentifier\": \"<string>\",\n \"reason\": \"<string>\"\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://api.nateq.io/api/v1/contacts/{id}/erasure-request")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"confirmIdentifier\": \"<string>\",\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nateq.io/api/v1/contacts/{id}/erasure-request")
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 \"confirmIdentifier\": \"<string>\",\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"actorUserId": "<string>",
"createdAt": "<string>",
"executedAt": "<string>",
"failureSummary": "<string>",
"id": "<string>",
"organizationId": "<string>",
"purgeAt": "<string>",
"reason": "<string>",
"requestedAt": "<string>",
"retentionCutoff": "<string>",
"retentionDataType": "<string>",
"status": "<string>",
"stores": [
{
"attemptedAt": "<string>",
"detail": "<string>",
"itemsDeleted": 123,
"status": "<string>",
"store": "<string>"
}
],
"subjectHash": "<string>",
"subjectType": "<string>",
"updatedAt": "<string>"
},
"error": {
"code": "<string>",
"details": "<unknown>",
"message": "<string>"
},
"message": "<string>",
"meta": {
"aiTranslation": "<string>",
"apiKeyUsage": {
"limit": 123,
"unlimited": true,
"used": 123
},
"count": 123,
"dataRetentionCapability": "<string>",
"endCursor": "<string>",
"hasNext": true,
"hasPrevious": true,
"limit": 123,
"page": 123,
"pageSize": 123,
"pendingCount": 123,
"routingCapability": "<string>",
"ssoCapability": "<string>",
"startCursor": "<string>",
"total": 123,
"totalPages": 123
},
"success": true
}{
"data": "<unknown>",
"error": {
"code": "<string>",
"details": "<unknown>",
"message": "<string>"
},
"message": "<string>",
"meta": {
"aiTranslation": "<string>",
"apiKeyUsage": {
"limit": 123,
"unlimited": true,
"used": 123
},
"count": 123,
"dataRetentionCapability": "<string>",
"endCursor": "<string>",
"hasNext": true,
"hasPrevious": true,
"limit": 123,
"page": 123,
"pageSize": 123,
"pendingCount": 123,
"routingCapability": "<string>",
"ssoCapability": "<string>",
"startCursor": "<string>",
"total": 123,
"totalPages": 123
},
"success": true
}{
"data": "<unknown>",
"error": {
"code": "<string>",
"details": "<unknown>",
"message": "<string>"
},
"message": "<string>",
"meta": {
"aiTranslation": "<string>",
"apiKeyUsage": {
"limit": 123,
"unlimited": true,
"used": 123
},
"count": 123,
"dataRetentionCapability": "<string>",
"endCursor": "<string>",
"hasNext": true,
"hasPrevious": true,
"limit": 123,
"page": 123,
"pageSize": 123,
"pendingCount": 123,
"routingCapability": "<string>",
"ssoCapability": "<string>",
"startCursor": "<string>",
"total": 123,
"totalPages": 123
},
"success": true
}{
"data": "<unknown>",
"error": {
"code": "<string>",
"details": "<unknown>",
"message": "<string>"
},
"message": "<string>",
"meta": {
"aiTranslation": "<string>",
"apiKeyUsage": {
"limit": 123,
"unlimited": true,
"used": 123
},
"count": 123,
"dataRetentionCapability": "<string>",
"endCursor": "<string>",
"hasNext": true,
"hasPrevious": true,
"limit": 123,
"page": 123,
"pageSize": 123,
"pendingCount": 123,
"routingCapability": "<string>",
"ssoCapability": "<string>",
"startCursor": "<string>",
"total": 123,
"totalPages": 123
},
"success": true
}Request erasure of a contact (GDPR Art. 17)
Permanently and irreversibly erases a contact and everything derived from them across every store. Requires a step-up token in X-Reauth-Token and the contact’s email or phone in confirmIdentifier. Returns 409 LEGAL_HOLD when the subject is under an active legal hold.
POST
/
contacts
/
{id}
/
erasure-request
Request erasure of a contact (GDPR Art. 17)
curl --request POST \
--url https://api.nateq.io/api/v1/contacts/{id}/erasure-request \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"confirmIdentifier": "<string>",
"reason": "<string>"
}
'import requests
url = "https://api.nateq.io/api/v1/contacts/{id}/erasure-request"
payload = {
"confirmIdentifier": "<string>",
"reason": "<string>"
}
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({confirmIdentifier: '<string>', reason: '<string>'})
};
fetch('https://api.nateq.io/api/v1/contacts/{id}/erasure-request', 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.nateq.io/api/v1/contacts/{id}/erasure-request",
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([
'confirmIdentifier' => '<string>',
'reason' => '<string>'
]),
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://api.nateq.io/api/v1/contacts/{id}/erasure-request"
payload := strings.NewReader("{\n \"confirmIdentifier\": \"<string>\",\n \"reason\": \"<string>\"\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://api.nateq.io/api/v1/contacts/{id}/erasure-request")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"confirmIdentifier\": \"<string>\",\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nateq.io/api/v1/contacts/{id}/erasure-request")
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 \"confirmIdentifier\": \"<string>\",\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"actorUserId": "<string>",
"createdAt": "<string>",
"executedAt": "<string>",
"failureSummary": "<string>",
"id": "<string>",
"organizationId": "<string>",
"purgeAt": "<string>",
"reason": "<string>",
"requestedAt": "<string>",
"retentionCutoff": "<string>",
"retentionDataType": "<string>",
"status": "<string>",
"stores": [
{
"attemptedAt": "<string>",
"detail": "<string>",
"itemsDeleted": 123,
"status": "<string>",
"store": "<string>"
}
],
"subjectHash": "<string>",
"subjectType": "<string>",
"updatedAt": "<string>"
},
"error": {
"code": "<string>",
"details": "<unknown>",
"message": "<string>"
},
"message": "<string>",
"meta": {
"aiTranslation": "<string>",
"apiKeyUsage": {
"limit": 123,
"unlimited": true,
"used": 123
},
"count": 123,
"dataRetentionCapability": "<string>",
"endCursor": "<string>",
"hasNext": true,
"hasPrevious": true,
"limit": 123,
"page": 123,
"pageSize": 123,
"pendingCount": 123,
"routingCapability": "<string>",
"ssoCapability": "<string>",
"startCursor": "<string>",
"total": 123,
"totalPages": 123
},
"success": true
}{
"data": "<unknown>",
"error": {
"code": "<string>",
"details": "<unknown>",
"message": "<string>"
},
"message": "<string>",
"meta": {
"aiTranslation": "<string>",
"apiKeyUsage": {
"limit": 123,
"unlimited": true,
"used": 123
},
"count": 123,
"dataRetentionCapability": "<string>",
"endCursor": "<string>",
"hasNext": true,
"hasPrevious": true,
"limit": 123,
"page": 123,
"pageSize": 123,
"pendingCount": 123,
"routingCapability": "<string>",
"ssoCapability": "<string>",
"startCursor": "<string>",
"total": 123,
"totalPages": 123
},
"success": true
}{
"data": "<unknown>",
"error": {
"code": "<string>",
"details": "<unknown>",
"message": "<string>"
},
"message": "<string>",
"meta": {
"aiTranslation": "<string>",
"apiKeyUsage": {
"limit": 123,
"unlimited": true,
"used": 123
},
"count": 123,
"dataRetentionCapability": "<string>",
"endCursor": "<string>",
"hasNext": true,
"hasPrevious": true,
"limit": 123,
"page": 123,
"pageSize": 123,
"pendingCount": 123,
"routingCapability": "<string>",
"ssoCapability": "<string>",
"startCursor": "<string>",
"total": 123,
"totalPages": 123
},
"success": true
}{
"data": "<unknown>",
"error": {
"code": "<string>",
"details": "<unknown>",
"message": "<string>"
},
"message": "<string>",
"meta": {
"aiTranslation": "<string>",
"apiKeyUsage": {
"limit": 123,
"unlimited": true,
"used": 123
},
"count": 123,
"dataRetentionCapability": "<string>",
"endCursor": "<string>",
"hasNext": true,
"hasPrevious": true,
"limit": 123,
"page": 123,
"pageSize": 123,
"pendingCount": 123,
"routingCapability": "<string>",
"ssoCapability": "<string>",
"startCursor": "<string>",
"total": 123,
"totalPages": 123
},
"success": true
}Authorizations
Your API key as a Bearer token: Authorization: Bearer tg_live_...
Path Parameters
Contact ID
Body
application/json
Confirmation
Was this page helpful?
⌘I