Consent

Set a customer's consent for receiving marketing communication.

Customers with identifier values that are opted-out will not receive marketing messages from Zaius to that identifier. Only transactional messages will be received by these customers.

Opt-In / Opt-out

Field

Value

consent (optional)

Boolean; defaults to true

identifier_field_name (optional)

defaults to 'email'

identifier_value (optional)

string

update_reason (optional)

string

update_ts (optional)

timestamp; defaults to current time

event_data (optional)

object holding additional event fields

zaius.consent({
consent: true,
identifier_field_name: 'email',
identifier_value: 'tyler@zaius.com',
update_reason: '',
update_ts: 123456789,
event_data: {}
});

Events

Zaius generates events automatically for the purposes of analytics and auditing. The events are structured as follows:

Event Type

Event Action

consent

opt-in

consent

opt-out