Record the consent basis
curl --request PUT \
--url https://apiv2.vodex.ai/v1/contacts/accounts/{id}/compliance \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"consentBasis": "<string>",
"consentCapturedAt": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://apiv2.vodex.ai/v1/contacts/accounts/{id}/compliance"
payload = {
"consentBasis": "<string>",
"consentCapturedAt": "2023-11-07T05:31:56Z"
}
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({consentBasis: '<string>', consentCapturedAt: '2023-11-07T05:31:56Z'})
};
fetch('https://apiv2.vodex.ai/v1/contacts/accounts/{id}/compliance', 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}/compliance",
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([
'consentBasis' => '<string>',
'consentCapturedAt' => '2023-11-07T05:31:56Z'
]),
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}/compliance"
payload := strings.NewReader("{\n \"consentBasis\": \"<string>\",\n \"consentCapturedAt\": \"2023-11-07T05:31:56Z\"\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}/compliance")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"consentBasis\": \"<string>\",\n \"consentCapturedAt\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.vodex.ai/v1/contacts/accounts/{id}/compliance")
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 \"consentBasis\": \"<string>\",\n \"consentCapturedAt\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"consentBasis": "<string>",
"consentCapturedAt": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"localTime": "<string>",
"window": {
"localStart": "09:00",
"localEnd": "20:00"
},
"windowState": "open",
"attemptsTotal": 123,
"attempts7d": 123,
"enforced": true
}{
"error": "not found"
}{
"error": "not found"
}Contacts
Record the consent basis
A single basis field with the time it was captured. Per-channel consent records with capture source and evidence refs are deliberately out of scope (0017 §8) — this is the honest amount of structure for what is actually collected today.
PUT
/
contacts
/
accounts
/
{id}
/
compliance
Record the consent basis
curl --request PUT \
--url https://apiv2.vodex.ai/v1/contacts/accounts/{id}/compliance \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"consentBasis": "<string>",
"consentCapturedAt": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://apiv2.vodex.ai/v1/contacts/accounts/{id}/compliance"
payload = {
"consentBasis": "<string>",
"consentCapturedAt": "2023-11-07T05:31:56Z"
}
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({consentBasis: '<string>', consentCapturedAt: '2023-11-07T05:31:56Z'})
};
fetch('https://apiv2.vodex.ai/v1/contacts/accounts/{id}/compliance', 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}/compliance",
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([
'consentBasis' => '<string>',
'consentCapturedAt' => '2023-11-07T05:31:56Z'
]),
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}/compliance"
payload := strings.NewReader("{\n \"consentBasis\": \"<string>\",\n \"consentCapturedAt\": \"2023-11-07T05:31:56Z\"\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}/compliance")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"consentBasis\": \"<string>\",\n \"consentCapturedAt\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.vodex.ai/v1/contacts/accounts/{id}/compliance")
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 \"consentBasis\": \"<string>\",\n \"consentCapturedAt\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"consentBasis": "<string>",
"consentCapturedAt": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"localTime": "<string>",
"window": {
"localStart": "09:00",
"localEnd": "20:00"
},
"windowState": "open",
"attemptsTotal": 123,
"attempts7d": 123,
"enforced": true
}{
"error": "not found"
}{
"error": "not found"
}Authorizations
Tenant API key (vdx_live_…) as Authorization: Bearer.
Path Parameters
Response
Recorded.
The time where they are, right now.
Local hours, in the contact's own timezone.
Show child attributes
Show child attributes
Available options:
open, closed, unknown Always false. The counts are displayed and gate nothing — a number that looks like a limit but is not one is worse than no number.