ConsentUpdate

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

Index

Properties

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.

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

consent_update_reason?

string

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

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

consent_update_ts?

string | number | Date

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.

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

event_data?

EventData

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

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

identifier_field_name

string

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

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

identifier_value

string

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

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