Consent

Updating consent modifies a customer's ability to receive marketing communications.

🚧
Important
Users who are opted-out cannot receive marketing messages from ODP on any channel.
Only transactional messages (for example, order receipt or, shipping notifications) will be received by these users.

Opt-in or 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

Consent example

Call the consent() method to opt-in and opt-out a customer.

📘
Note
consent defaults to true if you do not manually set the consent field.

zaius.consent({
  consent: true,
  identifier_field_name: 'email',
  identifier_value: '[email protected]',
  update_reason: '',
  update_ts: 123456789,
  event_data: {}
  });

zaius.consent({
  consent: false,
  identifier_field_name: 'email',
  identifier_value: '[email protected]',
  update_reason: '',
  update_ts: 123474189,
  event_data: {}
  });

Events

ODP 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