Mark a person do-not-contact, or clear it
curl --request PUT \
--url https://apiv2.vodex.ai/v1/contacts/accounts/{id}/dnc \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"doNotContact": true,
"reason": "<string>"
}
'import requests
url = "https://apiv2.vodex.ai/v1/contacts/accounts/{id}/dnc"
payload = {
"doNotContact": True,
"reason": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({doNotContact: true, reason: '<string>'})
};
fetch('https://apiv2.vodex.ai/v1/contacts/accounts/{id}/dnc', 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://apiv2.vodex.ai/v1/contacts/accounts/{id}/dnc",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'doNotContact' => true,
'reason' => '<string>'
]),
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://apiv2.vodex.ai/v1/contacts/accounts/{id}/dnc"
payload := strings.NewReader("{\n \"doNotContact\": true,\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://apiv2.vodex.ai/v1/contacts/accounts/{id}/dnc")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"doNotContact\": true,\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.vodex.ai/v1/contacts/accounts/{id}/dnc")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"doNotContact\": true,\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"doNotContact": true,
"reason": "<string>",
"setAt": "2023-11-07T05:31:56Z",
"entries": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "phone",
"value": "<string>",
"reason": "<string>",
"source": "account",
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z"
}
]
}{
"error": "not found"
}{
"error": "not found"
}Do Not Contact
Mark a person do-not-contact, or clear it
Setting the flag also writes suppression entries for that person’s
channels with source: account, because the address list is what the
dial path consults.
Clearing it removes only the entries that flag created. An address suppressed by uploading a regulator’s list survives — the alternative is one person toggling a switch and silently resuming calls the tenant is obliged to stop (0017 §2).
PUT
/
contacts
/
accounts
/
{id}
/
dnc
Mark a person do-not-contact, or clear it
curl --request PUT \
--url https://apiv2.vodex.ai/v1/contacts/accounts/{id}/dnc \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"doNotContact": true,
"reason": "<string>"
}
'import requests
url = "https://apiv2.vodex.ai/v1/contacts/accounts/{id}/dnc"
payload = {
"doNotContact": True,
"reason": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({doNotContact: true, reason: '<string>'})
};
fetch('https://apiv2.vodex.ai/v1/contacts/accounts/{id}/dnc', 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://apiv2.vodex.ai/v1/contacts/accounts/{id}/dnc",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'doNotContact' => true,
'reason' => '<string>'
]),
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://apiv2.vodex.ai/v1/contacts/accounts/{id}/dnc"
payload := strings.NewReader("{\n \"doNotContact\": true,\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://apiv2.vodex.ai/v1/contacts/accounts/{id}/dnc")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"doNotContact\": true,\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.vodex.ai/v1/contacts/accounts/{id}/dnc")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"doNotContact\": true,\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"doNotContact": true,
"reason": "<string>",
"setAt": "2023-11-07T05:31:56Z",
"entries": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "phone",
"value": "<string>",
"reason": "<string>",
"source": "account",
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z"
}
]
}{
"error": "not found"
}{
"error": "not found"
}Authorizations
Tenant API key (vdx_live_…) as Authorization: Bearer.