GetConsentResponse
ODP Node SDK / ODP / GetConsentResponse
Interface: GetConsentResponse
Defined in: src/Api/Types/Consent.ts:42
The response payload for fetching the consent status of a messaging identifier.
See V3 Consent API
Properties
consent
consent:
null
|boolean
Defined in: src/Api/Types/Consent.ts:55
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.
consent_update_reason
consent_update_reason:
null
|string
Defined in: src/Api/Types/Consent.ts:59
The reason for the update that last changed the consent status of this identifier
consent_update_ts
consent_update_ts:
null
|number
Defined in: src/Api/Types/Consent.ts:63
The time (unix epoch, seconds) of the last update that last changed the consent status of this identifier
identifier_field_name
identifier_field_name:
string
Defined in: src/Api/Types/Consent.ts:46
The name of the messaging identifier field, e.g., email
identifier_value
identifier_value:
string
Defined in: src/Api/Types/Consent.ts:50
The messaging identifier value this information is relevant to, such as a customer's email address
Updated 4 days ago