ODP Node SDK / Zaius / GetConsentResponse

GetConsentResponse

The response payload for fetching the consent status of a messaging identifier.
See V3 Consent API

Index

Properties

consent

null | boolean

true if a customer consented to receive marketing communications on this identifier, false if they have
opted out of marketing communcation, null if there has been no explicit consent or opt out.

Defined in: src/Api/Types/Consent.ts:55

consent_update_reason

null | string

The reason for the update that last changed the consent status of this identifier

Defined in: src/Api/Types/Consent.ts:59

consent_update_ts

null | number

The time (unix epoch, seconds) of the last update that last changed the consent status of this identifier

Defined in: src/Api/Types/Consent.ts:63

identifier_field_name

string

The name of the messaging identifier field, e.g., email

Defined in: src/Api/Types/Consent.ts:46

identifier_value

string

The messaging identifier value this information is relevant to, such as a customer's email address

Defined in: src/Api/Types/Consent.ts:50