Skip to main content

​
Method

GET /v1/people/:id/consent

​
Path Parameters

​
id
string
required
The person ID.

​
Headers

​
Authorization
string
required
Bearer token (requires customers:read).

​
Request Example

curl "https://api.voyantcloud.com/v1/people/people_01HZYPM2QF2R8X9SZQ0J9SYBCN/consent" \
  -H "Authorization: Bearer $VOYANT_API_KEY"

​
Response Fields

  • email – Boolean indicating if email marketing consent is granted.
  • sms – Boolean indicating if SMS marketing consent is granted.
  • email_details – Detailed consent record for email (or null if none).
  • sms_details – Detailed consent record for SMS (or null if none).
Each details object contains:
  • status – Consent status (granted or revoked).
  • granted_at – ISO timestamp when consent was granted.
  • revoked_at – ISO timestamp when consent was revoked.
  • source – How consent was captured (api, form, import, etc.).

​
Response Example

{
  "email": true,
  "sms": false,
  "email_details": {
    "status": "granted",
    "granted_at": "2025-01-15T10:30:00.000Z",
    "revoked_at": null,
    "source": "form"
  },
  "sms_details": {
    "status": "revoked",
    "granted_at": "2025-01-10T08:00:00.000Z",
    "revoked_at": "2025-01-20T14:00:00.000Z",
    "source": "api"
  }
}
If a person has never had consent recorded for a channel, the details object for that channel will be null and the boolean will be false.