Interface: ConsentUpdate

The payload for an ODP messaging identifier consent update via v3 APIs.
See V3 Consent API

Properties

consent

consent: boolean

true indicates the customer consented to receive marketing communications on this identifier,
false indicates the customer has explicitly revoked consent to receive marketing communications, e.g.,
checked a box saying "I do not want to receive marketing communications."
Providing false WILL REVOKE consent if an identifier was previously consented.

consent_update_reason?

optional consent_update_reason: string

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

A reason for updating consent. Should be human readable for audit purposes.

consent_update_ts?

optional consent_update_ts: string | number | Date

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

The time of the event if this is a historical change (defaults to current time).
Must be formated in ISO8601, provided as a Date object, or as a unix epoch.

event_data?

optional event_data: EventData

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

Additional event fields/values that should be included if an ODP event is generated as a result of this update

identifier_field_name

identifier_field_name: string

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

The name of the messaging identifier field you want to update, e.g., email

identifier_value

identifier_value: string

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

A valid messaging identifier value, such as an email address for the email identifier