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.

A profile can have associated attributes for communications. These cover promotional flags for email, post, phone, push and sms. These attributes determine the type of communications the member is able to be sent. See Comms preferences for a full explanation of opt-out flags, channel-level preferences, and verification states. 
{
  "profile_id": "907d9e6c-a24d-4a90-bd46-b433989de8e1",
  "email_optout": false,
  "push_optout": false,
  "sms_optout": false,
  "phone_optout": false,
  "post_optout": false,
  "email_bounced": false,
  "push_bounced": false,
  "sms_bounced": false,
  "phone_bounced": false,
  "post_bounced": false,
  "sms_promo": false,
  "push_promo": true,
  "email_promo": true,
  "phone_promo": false,
  "post_promo": false,
  "email_discover": true,
  "email_benefits": true,
  "email_reminders": true,
  "email_account": true,
  "email_bookings": true,
  "email_feedback": true,
  "email_location": false,
  "email_service": true,
  "sms_discover": false,
  "sms_benefits": false,
  "sms_reminders": true,
  "sms_account": false,
  "sms_bookings": true,
  "sms_feedback": false,
  "sms_location": false,
  "sms_service": true,
  "push_discover": true,
  "push_benefits": true,
  "push_reminders": true,
  "push_account": true,
  "push_bookings": true,
  "push_feedback": true,
  "push_location": true,
  "push_service": true,
  "phone_discover": true,
  "phone_benefits": true,
  "phone_reminders": true,
  "phone_account": true,
  "phone_bookings": true,
  "phone_feedback": true,
  "phone_location": true,
  "phone_service": true,
  "post_discover": true,
  "post_benefits": true,
  "post_reminders": true,
  "post_account": true,
  "post_bookings": true,
  "post_feedback": true,
  "post_location": true,
  "post_service": true,
  "email_verification": "not_sent",
  "sms_verification": "not_sent",
  "phone_verification": "not_sent",
  "post_verification": "not_sent",
  "terms_accepted_at": null,
  "terms_accepted_version": null,
  "created_at": "2020-05-05 15:20:32",
  "updated_at": "2020-05-05 15:20:32"
}

​
Properties

AttributeDescription
profile_id STRING READ-ONLYThe profile_id of the profile attached to the attributes
email_optout BOOLEANHas the member opted out of email notifications
push_optout BOOLEANHas the member opted out of push notifications
sms_optout BOOLEANHas the member opted out of sms notifications
phone_optout BOOLEANHas the member opted out of phone notifications
post_optout BOOLEANHas the member opted out of physical post marketing
email_bounced BOOLEANThis email address is no longer accepting emails and needs to be updated by the customers
push_bounced BOOLEANPush notifications have been disabled on device and needs to be re-enabled by the customer
sms_bounced BOOLEANMobile number is not deliverable and needs to be updated by the customer
phone_bounced BOOLEANthis phone number is no longer connected
post_bounced BOOLEANThis address has been marked as undeliverable or return to sender
sms_promo BOOLEANSelected news and offers via SMS messages
push_promo BOOLEANExclusive news and offers straight to your phone via push notifications
email_promo BOOLEANExclusive news and offers via email
phone_promo BOOLEANReceive calls from the brand for specific promotions and offers
post_promo BOOLEANSpecial items delivered to your postal address
{channel}_discover BOOLEANHelpful guides on how to get the most out of your account with us
{channel}_benefits BOOLEANNotifications whenever you’ve personally earned a benefit from us
{channel}_reminders BOOLEANReminders when benefits are about to expire so you don’t miss out
{channel}_account BOOLEANReceipts of your purchases and interactions and if account details are missing or out of date
{channel}_bookings BOOLEANNotifications and reminders of any bookings or appointments you’ve made with us
{channel}_feedback BOOLEANOpportunities to provide direct feedback on our brand, products and services
{channel}_location BOOLEANLocation specific reminders and notifications
{channel}_service BOOLEANNotifications or reminders about new or existing services
{channel}_verification STRINGThe current status of channel verification for the member. Accepted values are: not_sent, sent, delivered, undelivered, failed, verified
terms_accepted_at STRING DATE-TIMEThe UTC date & time the member has accepted the terms and conditions in ISO 8601 format.
terms_accepted_at_version STRINGThe version of the terms and conditions the user has accepted. If no versioning is kept, this can be null
created_at STRING DATE-TIMEThe UTC date & time the Profile record was created in ISO 8601 format.
updated_at STRING DATE-TIMEThe UTC date & time the Attributes record was last updated in ISO 8601 format.