Update a contact
curl --request PATCH \
--url https://apiv2.vodex.ai/v1/contacts/accounts/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"externalRef": "<string>",
"accountNumber": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"timezone": "<string>",
"dateOfBirth": "<string>",
"ssnLast4": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"status": "<string>",
"assignedTo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tags": [
"<string>"
],
"notes": "<string>",
"attributes": {},
"channels": [
{
"value": "<string>",
"isPrimary": true,
"isBad": true
}
]
}
'import requests
url = "https://apiv2.vodex.ai/v1/contacts/accounts/{id}"
payload = {
"externalRef": "<string>",
"accountNumber": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"timezone": "<string>",
"dateOfBirth": "<string>",
"ssnLast4": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"status": "<string>",
"assignedTo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tags": ["<string>"],
"notes": "<string>",
"attributes": {},
"channels": [
{
"value": "<string>",
"isPrimary": True,
"isBad": True
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
externalRef: '<string>',
accountNumber: '<string>',
firstName: '<string>',
lastName: '<string>',
email: '<string>',
timezone: '<string>',
dateOfBirth: '<string>',
ssnLast4: '<string>',
address: {
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
postalCode: '<string>',
country: '<string>'
},
status: '<string>',
assignedTo: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
tags: ['<string>'],
notes: '<string>',
attributes: {},
channels: [{value: '<string>', isPrimary: true, isBad: true}]
})
};
fetch('https://apiv2.vodex.ai/v1/contacts/accounts/{id}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'externalRef' => '<string>',
'accountNumber' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'email' => '<string>',
'timezone' => '<string>',
'dateOfBirth' => '<string>',
'ssnLast4' => '<string>',
'address' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'country' => '<string>'
],
'status' => '<string>',
'assignedTo' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'tags' => [
'<string>'
],
'notes' => '<string>',
'attributes' => [
],
'channels' => [
[
'value' => '<string>',
'isPrimary' => true,
'isBad' => true
]
]
]),
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}"
payload := strings.NewReader("{\n \"externalRef\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"timezone\": \"<string>\",\n \"dateOfBirth\": \"<string>\",\n \"ssnLast4\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"status\": \"<string>\",\n \"assignedTo\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"tags\": [\n \"<string>\"\n ],\n \"notes\": \"<string>\",\n \"attributes\": {},\n \"channels\": [\n {\n \"value\": \"<string>\",\n \"isPrimary\": true,\n \"isBad\": true\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://apiv2.vodex.ai/v1/contacts/accounts/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"externalRef\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"timezone\": \"<string>\",\n \"dateOfBirth\": \"<string>\",\n \"ssnLast4\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"status\": \"<string>\",\n \"assignedTo\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"tags\": [\n \"<string>\"\n ],\n \"notes\": \"<string>\",\n \"attributes\": {},\n \"channels\": [\n {\n \"value\": \"<string>\",\n \"isPrimary\": true,\n \"isBad\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.vodex.ai/v1/contacts/accounts/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalRef\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"timezone\": \"<string>\",\n \"dateOfBirth\": \"<string>\",\n \"ssnLast4\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"status\": \"<string>\",\n \"assignedTo\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"tags\": [\n \"<string>\"\n ],\n \"notes\": \"<string>\",\n \"attributes\": {},\n \"channels\": [\n {\n \"value\": \"<string>\",\n \"isPrimary\": true,\n \"isBad\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalRef": "<string>",
"accountNumber": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"displayName": "<string>",
"email": "<string>",
"timezone": "<string>",
"dateOfBirth": "<string>",
"ssnMasked": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"status": "<string>",
"assignedTo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tags": [
"<string>"
],
"notes": "<string>",
"lastContactedAt": "2023-11-07T05:31:56Z",
"lastContactChannel": "<string>",
"doNotContact": true,
"dncReason": "<string>",
"dncSetAt": "2023-11-07T05:31:56Z",
"consentBasis": "<string>",
"consentCapturedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"channels": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "phone",
"label": "primary",
"value": "<string>",
"isPrimary": true,
"verified": true,
"isBad": true,
"optedOutAt": "2023-11-07T05:31:56Z",
"lastGoodAt": "2023-11-07T05:31:56Z"
}
]
}{
"error": "not found"
}{
"error": "not found"
}Contacts
Update a contact
Partial. Only the fields present are written; channels is not editable
here — use the channel routes, so that adding a number and correcting a
name are separately auditable.
PATCH
/
contacts
/
accounts
/
{id}
Update a contact
curl --request PATCH \
--url https://apiv2.vodex.ai/v1/contacts/accounts/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"externalRef": "<string>",
"accountNumber": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"timezone": "<string>",
"dateOfBirth": "<string>",
"ssnLast4": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"status": "<string>",
"assignedTo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tags": [
"<string>"
],
"notes": "<string>",
"attributes": {},
"channels": [
{
"value": "<string>",
"isPrimary": true,
"isBad": true
}
]
}
'import requests
url = "https://apiv2.vodex.ai/v1/contacts/accounts/{id}"
payload = {
"externalRef": "<string>",
"accountNumber": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"timezone": "<string>",
"dateOfBirth": "<string>",
"ssnLast4": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"status": "<string>",
"assignedTo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tags": ["<string>"],
"notes": "<string>",
"attributes": {},
"channels": [
{
"value": "<string>",
"isPrimary": True,
"isBad": True
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
externalRef: '<string>',
accountNumber: '<string>',
firstName: '<string>',
lastName: '<string>',
email: '<string>',
timezone: '<string>',
dateOfBirth: '<string>',
ssnLast4: '<string>',
address: {
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
postalCode: '<string>',
country: '<string>'
},
status: '<string>',
assignedTo: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
tags: ['<string>'],
notes: '<string>',
attributes: {},
channels: [{value: '<string>', isPrimary: true, isBad: true}]
})
};
fetch('https://apiv2.vodex.ai/v1/contacts/accounts/{id}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'externalRef' => '<string>',
'accountNumber' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'email' => '<string>',
'timezone' => '<string>',
'dateOfBirth' => '<string>',
'ssnLast4' => '<string>',
'address' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'country' => '<string>'
],
'status' => '<string>',
'assignedTo' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'tags' => [
'<string>'
],
'notes' => '<string>',
'attributes' => [
],
'channels' => [
[
'value' => '<string>',
'isPrimary' => true,
'isBad' => true
]
]
]),
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}"
payload := strings.NewReader("{\n \"externalRef\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"timezone\": \"<string>\",\n \"dateOfBirth\": \"<string>\",\n \"ssnLast4\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"status\": \"<string>\",\n \"assignedTo\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"tags\": [\n \"<string>\"\n ],\n \"notes\": \"<string>\",\n \"attributes\": {},\n \"channels\": [\n {\n \"value\": \"<string>\",\n \"isPrimary\": true,\n \"isBad\": true\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://apiv2.vodex.ai/v1/contacts/accounts/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"externalRef\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"timezone\": \"<string>\",\n \"dateOfBirth\": \"<string>\",\n \"ssnLast4\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"status\": \"<string>\",\n \"assignedTo\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"tags\": [\n \"<string>\"\n ],\n \"notes\": \"<string>\",\n \"attributes\": {},\n \"channels\": [\n {\n \"value\": \"<string>\",\n \"isPrimary\": true,\n \"isBad\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.vodex.ai/v1/contacts/accounts/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalRef\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"timezone\": \"<string>\",\n \"dateOfBirth\": \"<string>\",\n \"ssnLast4\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"status\": \"<string>\",\n \"assignedTo\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"tags\": [\n \"<string>\"\n ],\n \"notes\": \"<string>\",\n \"attributes\": {},\n \"channels\": [\n {\n \"value\": \"<string>\",\n \"isPrimary\": true,\n \"isBad\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalRef": "<string>",
"accountNumber": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"displayName": "<string>",
"email": "<string>",
"timezone": "<string>",
"dateOfBirth": "<string>",
"ssnMasked": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"status": "<string>",
"assignedTo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tags": [
"<string>"
],
"notes": "<string>",
"lastContactedAt": "2023-11-07T05:31:56Z",
"lastContactChannel": "<string>",
"doNotContact": true,
"dncReason": "<string>",
"dncSetAt": "2023-11-07T05:31:56Z",
"consentBasis": "<string>",
"consentCapturedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"channels": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "phone",
"label": "primary",
"value": "<string>",
"isPrimary": true,
"verified": true,
"isBad": true,
"optedOutAt": "2023-11-07T05:31:56Z",
"lastGoodAt": "2023-11-07T05:31:56Z"
}
]
}{
"error": "not found"
}{
"error": "not found"
}Authorizations
Tenant API key (vdx_live_…) as Authorization: Bearer.
Path Parameters
Body
application/json
Only whitelisted columns may be written; anything else in the body is a 400, not a shrug.
Four digits. A full nine-digit SSN is rejected, not truncated.
Pattern:
^[0-9]{4}$Show child attributes
Show child attributes
Values keyed by attribute key.
Create only.
Show child attributes
Show child attributes
Response
Updated.
An integrator's own key. Only ever compared, never interpreted.
IANA zone. Injected as tz on every campaign row.
Always masked, e.g. ***-**-1234. Only four digits are stored; one place decides how to present them.
Show child attributes
Show child attributes
The person-level decision. Distinct from the address suppression list.
Show child attributes
Show child attributes