Search the Omeda Knowledge Base
-
-
-
-
- Behavior Lookup By Customer Id
- Customer Change Lookup
- Customer Comprehensive Lookup By Customer Id
- Customer Lookup By Customer Id
- Customer Lookup By Email Address
- Customer Lookup By EncryptedCustomerId
- Customer Lookup By External ID
- Customer Lookup By Name and Country
- Customer Lookup By PostalAddressId
- Customer Merge History Lookup
- Demographic Lookup By Customer Id
- Email Address Lookup By Customer Id
- External ID Lookup By Customer Id
- Phone Lookup By Customer Id
- Postal Address Lookup By Customer Id
- Subscription Lookup By Customer Id
- Subscription Lookup By Email
- Customer Lookup by Hashed Email Address
- Show all articles ( 3 ) Collapse Articles
-
- Email Deployment
- Email Audience Assignment Status
- Email Clicks
- Email Deployment Add Audience
- Email Deployment Approval Lookup
- Email Deployment Audience List FTP
- Email Deployment Cancel
- Email Deployment Clone
- Email Deployment Content
- Email Deployment Content Lookup
- Email Deployment Lookup
- Email Deployment Remove Audience
- Email Deployment Schedule
- Email Deployment Search
- Email Deployment Test
- Email Deployment Unschedule
- Email On Demand Send
- Email Opt In/Out Lookup
- Email Optin Queue
- Email Optout Queue
- Email Flag Email As Invalid
- Show all articles ( 6 ) Collapse Articles
-
-
- Release Notes for V18.10
- Release Notes for V18.11
- Release Notes for V18.12
- Release Notes for V18.13
- Release Notes for V18.14
- Release Notes for V18.15
- Release Notes for V18.16
- Release Notes for V18.9
- Release Notes for V19.1
- 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
- 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 V20.1
- Release Notes for V20.2
- Release Notes for V20.3
- Release Notes for V20.4
- Release Notes for V20.6
- Release Notes for V20.5
- 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 Preview for V20.13
- Release Preview for October 9, 2020
- Release Notes for V20.12
- Release Preview for October 30, 2020
- Release Preview for November 20, 2020
- Release Preview for December 11, 2020
- Release Notes - January 8th, 2021
- Show all articles ( 28 ) Collapse Articles
-
-
-
- Customer Olytics Data
- Form Listener
- Olytics - Integration Description
- Olytics - Product Outline
- Olytics Comprehensive Lookup
- Olytics Customer Search
- Olytics Customer Top Values
- Reports - Web Behavior Reporting
- Web Behavioral Tracking (Olytics) - Overview & Capabilities
- Audience Builder (OnQ) - Querying Olytics Fields
-
-
-
-
-
- Email - Clickbot Reporting
- Reports - Audience Builder (OnQ) Reporting
- Reports - Audience Overlap Report
- Reports - Audience Report
- Reports - Data Tracker Reporting
- Reports - Email Reporting
- Reports - Issue Activity Reporting
- Reports - Web Behavior Reporting
- Reports - Overview
- Reports- FAQs
- Reports - Email Device and Client Type Reporting
-
-
-
- Email Deployment
- Email Audience Assignment Status
- Email Clicks
- Email Deployment Add Audience
- Email Deployment Approval Lookup
- Email Deployment Audience List FTP
- Email Deployment Cancel
- Email Deployment Clone
- Email Deployment Content
- Email Deployment Lookup
- Email Deployment Remove Audience
- Email Deployment Schedule
- Email Deployment Search
- Email Deployment Test
- Email Deployment Unschedule
- Email On Demand Send
- Email Opt In/Out Lookup
- Email Optin Queue
- Email Optout Queue
- Email Flag Email As Invalid
- Email - Checklist for Sends Created via API Calls
- Show all articles ( 6 ) Collapse Articles
- Email - A/B Testing
- Email - Advanced Features
- Email - Appending Lists On Triggered Deployments
- Email - Assigning Link Tracking Categories
- Email - Automated ACS Notifications
- Email - Deliverability
- Email - Deployment Checklist & Best Practices
- Email - Dynamic Content
- Email - FAQs
- Omeda - Getting Support
- Email - Glossary
- Email - Link Tracking Errors
- Email - Merge Variables
- Email - Preference Page
- Email - Recurring Deployments
- Email - Triggered Deployments
- Email - User Set-up
- Email - Web Tracking
- Email - Web Tracking String Parameter Definitions
- Email Builder - Getting Started
- Email - Stealth Link
- Email - Clickbot Reporting
- Email - Validation Services
- Email - Opt-Out Footer Merge Variable
- Reports - Email Reporting
- Email - Whitelisting Email Newsletters
- Email - Request a New Deployment Type
- Email - Behavioral Data
- Email - Deployment Defaults
- Email - Deployment Type Creation
- Show all articles ( 15 ) Collapse Articles
-
-
-
- Odyssey - Audience Element
- Odyssey - Timing Elements
- Odyssey - Email Element
- Odyssey - Filter Element
- Odyssey - Form Submit Element
- Odyssey - Export Element
- Odyssey - Split Element
- Odyssey - Personalization Element
- Odyssey - Metering Element
- Odyssey - Pathfinder Element
- Odyssey - Google Ad Manager Element
- Odyssey - Adroll Elements
- Odyssey - Facebook Elements
- Odyssey - Goal Element
- Odyssey Overview
- Odyssey - FAQs
- Odyssey - Reporting
- Odyssey - Querying Element Visitors in Audience Builder
- Odyssey - Using Profiles
- Odyssey - Email Merge Variables
- Odyssey - Omeda's Email Designer
- Odyssey - Email Designer Templates
- Odyssey - Merging Paths
- Odyssey - Creating Custom Templates
- Odyssey - Voyage Templates
- Odyssey - Editing an In Progress Voyage
- Odyssey - Error Troubleshooting
- Odyssey - Dynamic Content
-
-
-
-
- Audience Builder (OnQ) - Admin User Guide
- Audience Builder (OnQ) - How To Query Customers
- Audience Builder (OnQ) - Match Evaluation
- Audience Builder (OnQ) - Overview
- Audience Builder (OnQ) - Query Result Outputs
- Reports - Audience Builder (OnQ) Reporting
- Email - Behavioral Data
- Audience Builder (OnQ) - Advanced Features
- Audience Builder (OnQ) - Querying Olytics Fields
-
-
-
-
-
- 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 Use A/B Testing on your Dragon Webform (video)
- How To Use Progressive Profiling
- How to send a user back to your website after form submission (redirect to a return URL)
- Best practices for testing forms
- Dragon Forms URL Structure and Appending Parameters
- Form Builder (Dragon) - Overview
- Form Builder (Dragon) Themes
- Form Builder ADA Compliance
- Styling Your Dragon Webforms
- Test links v. live links
- Using a Custom Domain for your Dragon Webform
- Using Dragon Form Builder to capture a Behavior Subscription Attribute
- 2020 Form Builder Updates
-
-
-
Email Deployment Content Lookup
- Knowledge Base Home
- Documentation
- API & Webservices
- Email Builder APIs
- Email Deployment Content Lookup
Summary
An api available to our omail clients.
For a given set of url parameters – the API will return the text or html content for a given omail deployment and specified split.
General Technical Requirements
The following technical requirements apply to all requests for this API.
Base Resource URI
Production: https://ows.omeda.com/webservices/rest/brand/{brandAbbreviation}/omail/deployment/content/lookup/{textOrHtml}/{trackingNumber}/{splitSequence}/* Testing: https://ows.omedastaging.com/webservices/rest/brand/{brandAbbreviation}/omail/deployment/content/lookup/{textOrHtml}/{trackingNumber}/{splitSequence}/*
- brandAbbreviation
- is the abbreviation for the brand
- textOrHtml
- valid values are “text” or “html” and determine whether the API returns the text version of the deployment content or the html version of the deployment content.
- trackingNumber
- is the tracking number for the omail deployment.
- splitSequence
- is the split sequence of the omail deployment. If the deployment has multiple splits, you would pass ‘1’ to see split 1’s content, etc.
HTTP Headers
The HTTP header must contain the following elements:
- x-omeda-appid
- a unique id provided to you by Omeda to access your data. The request will fail without a valid id.
Content Type
The content type is text/html.
Supported HTTP Methods
There is one HTTP method supported:
- GET
- See W3C’s GET specs for details.
Example URL to retrieve the html content from split 1 of omail deployment ACME190211008:
https://ows.omedastaging.com/webservices/rest/brand/ACME/omail/deployment/content/lookup/html/ACME190211008/1/*
Example URL to retrieve the text content from split 2 of omail deployment ACME141001003:
https://ows.omedastaging.com/webservices/rest/brand/ACME/omail/deployment/content/lookup/text/ACME141001003/2/*
Success Response will return the content corresponding to the search values in the lookup URL.
Last Updated On
Table of Contents