Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

Communication preferences in Omneo are stored as part of the profile’s Comms Attributes. These fields capture whether a customer has opted in or out of each communication type and channel, and are synchronised in real-time to connected comms platforms.

Comms attribute fields

Comms attributes are grouped by channel and purpose:

Opt-out flags

FieldDescription
email_optoutCustomer has globally opted out of email
sms_optoutCustomer has globally opted out of SMS
push_optoutCustomer has globally opted out of push notifications
phone_optoutCustomer has opted out of phone calls
post_optoutCustomer has opted out of postal mail

Promotional opt-ins

Granular opt-in flags per channel:
  • email_promo, sms_promo, push_promo, phone_promo, post_promo

Category-level preferences

Fine-grained preferences for specific communication purposes (available for email, SMS, push, phone, and post):
  • _discover — product discovery and new arrivals
  • _benefits — incentive notifications and benefit alerts
  • _reminders — reminders and follow-ups
  • _account — account-related notifications
  • _bookings — appointment and booking confirmations
  • _feedback — surveys and feedback requests
  • _location — location-specific communications
  • _service — service and support communications

Bounce and verification flags

FieldDescription
email_bouncedEmail address has hard bounced
sms_bouncedSMS has failed delivery
email_verificationVerification status: not_sent, sent, verified

Where preferences are managed

Customers can update their preferences via:
  • Profile Portal — the customer-facing self-service surface
  • Comms platform (e.g., Klaviyo unsubscribe link) — changes are synced back to Omneo
  • CX Manager — admin-level updates
  • Clienteling — in-store staff updates
Changes made in any connected system are propagated to all others in real time via webhook synchronisation. Omneo’s comms preferences model is designed to support compliant consent collection and management. The granular opt-in fields allow brands to collect category-level consent rather than a single “subscribe/unsubscribe” flag, enabling more precise compliance with email marketing regulations.

Opting out and suppressing a profile

To suppress a profile from all communications, set the relevant _optout flags via the API. These are respected by Omneo’s notification logic and synced in real time to connected comms platforms. For broader suppression — excluding a profile from incentive automations, imports, or operational logic — use tags or statuses as a signal. See Profile blacklist and opt-out for implementation details.