Search the Omeda Knowledge Base
-
The Omeda Experience
-
Documentation
-
-
- Brand Comprehensive Lookup Service
- Brand Promotions Quantity
- Brand Group Lookup
- Brand Promotions Content By Promo Code
- Brand Promotions By Promo Code
- Behavior Categories Lookup
- Behavior Actions Lookup
- Behavior Lookup Grouped By Product
- Behavior Lookup By Id
- Behavior Lookup
- Demographic Lookup by Brand API
- Deployment Type Lookup by Brand API
- Product Lookup by Brand API
-
- Customer Lookup By Email Address
- Subscription Lookup By Customer Id
- Order History Lookup by Customer Id
- Customer Lookup by Hashed Email Address
- Email Address Lookup By Customer Id
- Gift Lookup by Donor ID
- Behavior Lookup By Customer Id
- Subscription Lookup By Email
- Customer Merge History Lookup
- Customer Lookup By Name and Country
- External ID Lookup By Customer Id
- Demographic Lookup By Customer Id
- Phone Lookup By Customer Id
- Postal Address Lookup By Customer Id
- Customer Change Lookup
- Customer Comprehensive Lookup By Customer Id
- Customer Lookup By EncryptedCustomerId
- Customer Lookup By External ID
- Customer Lookup By PostalAddressId
- Customer Lookup By Customer Id
- Email Validity Lookup API
- Show all articles ( 6 ) Collapse Articles
-
- Email On Demand Send
- Email Deployment
- Email Deployment Clone
- Email Deployment Remove Audience
- Email Audience Assignment Status
- Email Deployment Content
- Email Deployment Approval Lookup
- Email Deployment Schedule
- Email Deployment Cancel
- Email Deployment Search
- Email Flag Email As Invalid
- Email Clicks
- Email - Checklist for Sends Created via API Calls
- Email Deployment Content Lookup
- Email Deployment Unschedule
- Email Deployment Lookup
- Email Deployment Test
- Email Deployment Add Audience
- Email Opt In/Out Lookup
- Email Optout Queue
- Email Optin Queue
- Email Deployment Audience List FTP
- Show all articles ( 7 ) Collapse Articles
-
-
- Release Notes for Jan 27 | V23.2
- Release Notes for Feb 17 | V23.3
- Release Notes for Mar 10 | V23.4
- Release Notes for Mar 31 | V23.5
- Release Notes for Apr 21 | V23.6
- Release Notes for May 19 | V23.7
- Release Notes for June 2 | V23.8
- Release Notes for June 23 | V23.9
- Release Notes for July 14 | V23.10
- Release Notes for Aug 4 | V23.11
- Release Notes for Aug 25 | V23.12
- Release Notes for Sep 15 | V23.13
- Release Notes for Oct 6 | V23.14
- Release Notes for Oct 27 | V23.15
- Release Notes for Nov 16 | V23.16
- Release Notes for V23.17
- Show all articles ( 1 ) Collapse Articles
-
- Release Notes for Jan 14 | V22.1
- Release Notes for Feb 4 | V22.2
- Release Notes for Feb 25 | V22.3
- Release Notes for Mar 18 | V22.4
- Release Notes for Apr 8 | V22.5
- Release Notes for Apr 29 | V22.6
- Release Notes for May 20 | V22.7
- Release Notes for June 10 | V22.8
- Release Notes for July 1 | V22.9
- Release Notes for July 22 | V22.10
- Release notes for Aug 12 | V22.11
- Release Notes for Sep 2 | V22.12
- Release Notes for Sep 23 | V22.13
- Release Notes for Oct 14 | V22.14
- Release Notes for Nov 4 | V22.15
- Release Notes for Dec 2 | V22.16
- Show all articles ( 1 ) Collapse Articles
-
- Release Notes for V21.1
- Release Notes for V21.2
- Release Notes for V21.3
- Release Notes for V21.4
- Release Notes for V21.5
- Release Notes for V21.6
- Release Notes for V21.7
- Release Notes for V21.8
- Release Notes for V21.9
- Release Notes for V21.10
- Release Notes for V21.11
- Release Notes for V21.12
- Release Notes for V21.13
- Release Notes for V21.14
- Release Notes for V21.15
- Release Notes for V21.16
- Release Notes for V21.17
- Show all articles ( 2 ) Collapse Articles
-
- Release Notes for V20.1
- Release Notes for V20.2
- Release Notes for V20.3
- Release Notes for V20.4
- Release Notes for V20.5
- Release Notes for V20.6
- Release Notes for V20.7
- Release Notes for V20.8
- Release Notes for V20.9
- Release Notes for V20.10
- Release Notes for V20.11
- Release Notes for V20.12
- Release Notes for V20.13
- Release Notes for V20.14
- Release Notes for V20.15
- Release Notes for V20.16
- Release Notes for V20.17
- Show all articles ( 2 ) Collapse Articles
-
- Release Notes for V19.1
- Release Notes for V19.2
- Release Notes for V19.3
- Release Notes for V19.4
- Release Notes for V19.5
- Release Notes for V19.6
- Release Notes for V19.7
- Release Notes for V19.8
- Release Notes for V19.9
- Release Notes for V19.10
- Release Notes for V19.11
- Release Notes for V19.12
- Release Notes for V19.13
- Release Notes for V19.14
- Release Notes for V19.15
- Release Notes for V19.16
- Release Notes for V19.17
- Show all articles ( 2 ) Collapse Articles
-
-
CDP – Customer Data Platform
-
-
- Personalization Overview
- Personalization - FAQs
- Personalization - Reporting
- Personalization - Archiving & Restoring
- Personalization - HTML Templates
- Personalization - Scroll Trigger and Infinite Scroll Pages
- Personalization - Merge Variables
- Personalization - 'Generate Personalization' Option
- Personalization & Metering - Click Tracking
- GDPR Consent Management
- Form Builder - Embedding Webforms via iFrame or Javascript
-
-
Integrations
-
-
- Integration with Zapier
- Bring Customer Data in via Webhooks by Zapier Action - POST Event
- Bring Customer Data in using Zapier
- Omeda's Add Customer Action in Zapier
- Send Form Submission Data via Zapier
- Bring Customer Data in via Webhooks by Zapier Action – Custom Request Event
- Formatter by Zapier Action
-
-
-
Analytics & Reporting
-
- Odyssey - Reporting
- Personalization - Reporting
- Reports - Email Device and Client Type Reporting
- Email - Clickbot Reporting
- Reports - Email Reporting
- Metering - Reporting
- Reports - Audience Overlap Report
- Reports - Engaged Companies Report
- Reports-AutoRenewals Analysis Report
- Reports - Audience Report
- Reports - Issue Activity Reporting
- Reports - Overview
- Reports - Web Behavior Reporting
- Reports- FAQs
- Reports - Data Tracker Reporting
- Reports - Audience Builder Reporting
- Form Submit Report
- Behavior Promo Code Report
- Reporting Library
- Show all articles ( 4 ) Collapse Articles
-
Marketing Automation & Email Builder
-
-
- Email On Demand Send
- Email Deployment
- Email Deployment Clone
- Email Deployment Remove Audience
- Email Audience Assignment Status
- Email Deployment Content
- Email Deployment Approval Lookup
- Email Deployment Schedule
- Email Deployment Cancel
- Email Deployment Search
- Email Flag Email As Invalid
- Email Clicks
- Email - Checklist for Sends Created via API Calls
- Email Deployment Lookup
- Email Deployment Test
- Email Deployment Add Audience
- Email Opt In/Out Lookup
- Email Optout Queue
- Email Optin Queue
- Email Deployment Audience List FTP
- Show all articles ( 5 ) Collapse Articles
- Email Builder - User Guide
- Email - Clickbot Reporting
- Reports - Email Reporting
- Email - Link Tracking Errors
- Email - Deployment Defaults
- Omeda - Getting Support
- Email - Checklist for Sends Created via API Calls
- Email - Assigning Link Tracking Categories
- Email - Deliverability
- Email - Opt-Out Footer Merge Variable
- Email - Stealth Link
- Email - Behavioral Data
- Email - Automation for Email Sending
- Email - Checklist for New Clients
- Email - Deployment Type Creation
- Email – Training Schedules for New Clients
- Email - Request a New Deployment Type
- Email - Adding Domains to Safe Sender List
- Email - Deployment Checklist & Best Practices
- Email Deployment Unschedule
- Email Builder - Getting Started
- Campaign Tool - Overview
- Email - Automated ACS Notifications
- Email - Dynamic Content
- Email - Recurring Deployments
- Email - FAQs
- Email - Web Tracking
- Email - Validation Services
- Email Services - Overview & Capabilities
- Email - Web Tracking String Parameter Definitions
- Email - Appending Lists On Triggered Deployments
- Email - Preference Page
- Email - A/B Testing
- Email - Triggered Deployments
- Email - Merge Variables
- Email - User Set-up
- Email - Advanced Features
- Email - Glossary
- Show all articles ( 23 ) Collapse Articles
-
-
-
- Odyssey - Audience Element
- Odyssey - Timing Elements
- Odyssey - Adroll Elements
- Odyssey - Facebook Elements
- Odyssey - Filter Element
- Odyssey - Form Submit Element
- Odyssey - Pathfinder Element
- Odyssey - Export Element
- Odyssey - Split Element
- Odyssey - Personalization Element
- Odyssey - Metering Element
- Odyssey - Email Element
- Odyssey - Goal Element
- Odyssey - A/B Test Element
- Odyssey - Google Ad Manager Element
- Odyssey Fatigue Filter Element
- Show all articles ( 1 ) Collapse Articles
- Odyssey Overview
- Odyssey - FAQs
- Odyssey - Editing an In Progress Voyage
- Odyssey - Reporting
- Odyssey - Querying Element Visitors in Audience Builder
- Odyssey - Using Profiles
- Odyssey - Creating Custom Templates
- Odyssey - Global Settings
- Odyssey - Email Conditions
- Odyssey - Omeda's Email Designer
- Odyssey - Email Designer Templates
- Odyssey - Voyage Templates
- Odyssey - Merging Paths
- Odyssey - Email Merge Variables
- Odyssey - Error Troubleshooting
- Odyssey - Dynamic Content
- Show all articles ( 1 ) Collapse Articles
-
-
-
Data Management & Governance
-
- Odyssey - Querying Element Visitors in Audience Builder
- Audience Builder - Product Field Library
- Examples of Audience Builder Queries Using Paid Fields
- Querying Your Olytics Data
- Data Loader - Querying in Audience Builder
- Email - Behavioral Data
- Audience Builder (OnQ) - Date Field Definitions
- Audience Builder - How To Query Customers
- Audience Builder (OnQ) - Query Result Outputs
- Audience Builder - Overview
- Reports - Audience Builder Reporting
- Audience Builder - Admin User Guide
- Audience Builder (OnQ) - Advanced Features
- Audience Builder (OnQ) - Match Evaluation
-
-
Subscription & Fulfillment Management
-
Forms & Landing Pages
-
- Form Builder - Form Dashboard
- Form Builder - Content
- Form Builder - Settings
- Form Builder - Create a Form
- Form Builder - Expressions
- Form Builder - Form Categories and Form Types
- Form Builder - Overview
- Using a Custom Domain for your Form Builder Webform
- Form Builder Forms URL Structure and Appending Parameters
- Best Practices for Testing Forms
- Styling Your Form Builder Forms
- Form Builder ADA Compliance
- Form Builder - reCAPTCHA v3 Implementation
- Form Builder - Error Log
- Form Builder - Payment Gateways
-
- How To Use A/B Testing on your Form Builder Webform (video)
- How to conditionally display a question on your form (video)
- How to create and add an email confirmation to your form (video)
- How to update a demographic (video)
- How to send a user back to your website after form submission (redirect to a return URL)
- Form Builder - Integrations
- Form Builder - Adding a This Is Not Me Widget
- Form Builder - Embedding Webforms via iFrame or Javascript
- How To Use Progressive Profiling
- Form Builder - Using the PayPal Payment Method
- Form Builder - Using Campaign Promo Codes
- Using Form Builder to capture a Behavior Subscription Attribute
- Form Builder - reCAPTCHA v3 Implementation
-
-
Success Use Cases
-
Professional Services
-
Video Library
-
FAQs
< All Topics
Print
API – Overview
Customer Lookup
The following APIs allow you to lookup various types of customer data on your database.
- Customer Lookup By Id : Lookup customer identity information with an id.
- Customer Lookup By PostalAddressId : Lookup customer identity information with a PostalAddressId.
- Customer Lookup Service By External ID : Lookup customer identity information with an External ID used by client or an Omeda legacy ID.
- Customer Lookup By Encrypted Id : Allows various approaches for querying the database and returning customer info that match particular values.
- Customer Lookup By Email : Allows various approaches for querying the database and returning customer info that match particular values.
- Comprehensive Customer Lookup: Provides complete identity, contact, and demographic information about a customer in one call.
- Customer Change Lookup : Find all customers changed within a specified date range.
- Postal Address Lookup : Find address information for a specified customer.
- Phone Number Lookup : Find phone information for a customer.
- Email Address Lookup : Finds email address information for a customer.
- Demographic Lookup : Finds customer demographic information for a customer.
- Subscription Lookup: Finds customer subscription information for a customer.
- Subscription Lookup By Product: Finds customer subscription information for a customer AND specific product.
- Subscription Lookup by Email: Finds subscription information for all customers with the given email address and product (if requested).
- Behavior Lookup : Finds behavior information for a customer.
- External ID Lookup : Finds External ID and Namespace for a customer.
- Customer Lookup By Name and Country : Allows various approaches for querying the database and returning customer info that match particular name and Country.
- Customer Merge History Service : Finds all “loser” customers associated with the requested Customer Id.
Store Customer Info
These services allow you to store customer and orders in your database.
- Save Customer and Order API : Save customer and product information in one transaction.
- Save Customer and Order API with PAID fields : Save customer and product information where there is a paid aspect to the order.
- Check Customer Processing Status : Check the status of a customer add or update.
- Check Order Processing Status : Check the status of a new order.
- Assign Behavior : Add customer behavior data.
- Assign Behavior Bulk : Assign an existing behavior to a customer.
Brand Lookup
The following APIs allow you to lookup various types of brand level data on your database.
- Brand Comprehensive Lookup (Cross Reference) : Retrieves information about a brand, including all its demographics, valid values, contact types, and other information useful for cross referencing data.
- Behavior Lookup : Retrieves information about brand Behaviors.
- Behavior Lookup By Id : Retrieves information about brand Behaviors by the Behavior ID.
- Behavior Lookup By Product : Retrieves information about brand Behaviors, grouped by Product.
- Behavior Actions Lookup : Retrieves information about brand Behavior Action.
- Behavior Categories Lookup : Retrieves information about brand Behavior Categories.
- Brand Promotions By Promo Code Lookup : Retrieves information about a specific brand Promotion.
- Brand Promotions Specified Quantity Lookup : Retrieves the most recent Brand Promotion information and returns the specified quantity.
- Brand Promotion Content By Promo Code Lookup : Retrieves the Brand Promotion Content for the specified Promo Code.
- Brand Group Lookup : Retrieves all information for the specified groupId.
Store Brand Info
These services allow you to store brand level data in your database.
- Store Behavior : Creates Behaviors.
- Store Behavior Action : Creates Behavior Actions.
- Store Behavior Category : Creates Behavior Category.
- Assign Behavior Category : Assign a Behavior to a Category.
- Store Behavior Attribute : Creates/update Behavior Attribute.
Authentication
- Add Authentication : Adds a username and password to an existing customer.
- Validate Authentication : Validates a username and password.
- Update Authentication : Update a customers existing username and/or password.
- Reset Password Authentication : Resets an existing username’s associated password.
- Activate Authentication : Activate a customer’s existing record (status code = 2).
If you are using Email Builder, or are using your database to store opt-in and opt-out information by email addresses, these APIs are available for your use.
- Optin API : This service allows submission of optin data.
- Optout API : This service allows submission of optout data.
- Opt Lookup API : Finds Opt In/Out information for a given email address.
- On Demand Send API: This service will send a single email via a special Omail deployment.
- Deployment Audience List FTP : Upload a list of customer information to the Omail system via FTP.
- Deployment : Create/Update an Omail deployment.
- Deployment Clone : Clone an Omail deployment.
- Deployment Add Audience : Add an OnQ Query or Recipient List to a deployment.
- Deployment Remove Audience : Remove a list or query assigned to a deployment.
- Audience Assignment Status : The List Assignment Status API checks completion status of the list as it is processed and assigned to the deployment.
- Deployment Content : Manage the HTML/Text content for a deployment.
- Deployment Test : Send a test deployment.
- Deployment Test Approval Lookup : Lookup information for a deployment’s tests.
- Deployment Schedule : Schedule a deployment to be sent.
- Deployment Unschedule : Unschedule a deployment.
- Deployment Cancel : Cancel a deployment.
- Deployment Search : Search the system for deployments matching search parameters.
- Deployment Lookup : Retrieve deployment information for a given deployment. Information includes but is not limited to link tracking, delivery statistics, content, history, etc.
- Invalid Email API : Flag an email address as invalid.
- Click Lookup API : Retrieve Customer Click information for a given deployment.
Utility
These “dictionary” APIs provide decode capabilities for your value ids/descriptions used for demographics, products, postal information, etc.
- Postal Information : This service allows to receive postal information for a given postal code.
- Run Processor API : This service allows you to run the processor for one or many pending transactions.
- Tax Rate Lookup API : This service allows you to lookup the tax rate for a customer based on the product id and the location.
olytics
- Customer Top olytics Values : This service returns the most frequent olytics traffic values for a given customer. This can be useful in targeted content or advertisements.
Tags:
Table of Contents