Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
curl -X PATCH "https://api.voyantcloud.com/v1/people/people_01HZYPM2QF2R8X9SZQ0J9SYBCN/consent" \
-H "Authorization: Bearer $VOYANT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"channel": "email",
"granted": true
}'
curl -X PATCH "https://api.voyantcloud.com/v1/people/people_01HZYPM2QF2R8X9SZQ0J9SYBCN/consent" \
-H "Authorization: Bearer $VOYANT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"channel": "sms",
"granted": false
}'
const personId = "people_01HZYPM2QF2R8X9SZQ0J9SYBCN"
// Grant email consent
const res = await fetch(
`https://api.voyantcloud.com/v1/people/${personId}/consent`,
{
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.VOYANT_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
channel: "email",
granted: true,
}),
}
)
const result = await res.json()
import os, requests
person_id = "people_01HZYPM2QF2R8X9SZQ0J9SYBCN"
# Grant email consent
resp = requests.patch(
f"https://api.voyantcloud.com/v1/people/{person_id}/consent",
json={"channel": "email", "granted": True},
headers={"Authorization": f"Bearer {os.environ['VOYANT_API_KEY']}"},
)
result = resp.json()
{
"channel": "email",
"granted": true,
"updated_at": "2025-01-15T10:30:00.000Z"
}
{
"error": "Person not found"
}
{
"error": "Invalid request body",
"code": "VALIDATION_400",
"details": [
{
"code": "invalid_enum_value",
"message": "Invalid enum value. Expected 'email' | 'sms', received 'push'",
"path": ["channel"]
}
]
}
Update marketing consent status for a person (email or SMS).
PATCH /v1/people/:id/consent
customers:write).application/jsonemail or sms.true) or revoked (false).curl -X PATCH "https://api.voyantcloud.com/v1/people/people_01HZYPM2QF2R8X9SZQ0J9SYBCN/consent" \
-H "Authorization: Bearer $VOYANT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"channel": "email",
"granted": true
}'
curl -X PATCH "https://api.voyantcloud.com/v1/people/people_01HZYPM2QF2R8X9SZQ0J9SYBCN/consent" \
-H "Authorization: Bearer $VOYANT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"channel": "sms",
"granted": false
}'
const personId = "people_01HZYPM2QF2R8X9SZQ0J9SYBCN"
// Grant email consent
const res = await fetch(
`https://api.voyantcloud.com/v1/people/${personId}/consent`,
{
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.VOYANT_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
channel: "email",
granted: true,
}),
}
)
const result = await res.json()
import os, requests
person_id = "people_01HZYPM2QF2R8X9SZQ0J9SYBCN"
# Grant email consent
resp = requests.patch(
f"https://api.voyantcloud.com/v1/people/{person_id}/consent",
json={"channel": "email", "granted": True},
headers={"Authorization": f"Bearer {os.environ['VOYANT_API_KEY']}"},
)
result = resp.json()
{
"channel": "email",
"granted": true,
"updated_at": "2025-01-15T10:30:00.000Z"
}
{
"error": "Person not found"
}
{
"error": "Invalid request body",
"code": "VALIDATION_400",
"details": [
{
"code": "invalid_enum_value",
"message": "Invalid enum value. Expected 'email' | 'sms', received 'push'",
"path": ["channel"]
}
]
}
source field will be set to api for all updates made through this endpoint.