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
- Order History Lookup by Customer Id
- Show all articles ( 4 ) 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 V20.17
- Release Notes for V20.16
- Release Notes for V20.15
- Release Notes for V20.14
- Release Notes for V20.13
- Release Notes for V20.12
- Release Notes for V20.11
- Release Notes for V20.10
- Release Notes for V20.9
- Release Notes for V20.8
- Release Notes for V20.7
- Release Notes for V20.6
- Release Notes for V20.5
- Release Notes for V20.4
- Release Notes for V20.3
- Release Notes for V20.2
- Release Notes for V20.1
- Show all articles ( 2 ) Collapse Articles
-
- Release Notes for V19.17
- Release Notes for V19.16
- Release Notes for V19.15
- Release Notes for V19.14
- Release Notes for V19.13
- Release Notes for V19.12
- Release Notes for V19.11
- Release Notes for V19.10
- Release Notes for V19.9
- Release Notes for V19.8
- Release Notes for V19.7
- Release Notes for V19.6
- Release Notes for V19.5
- Release Notes for V19.4
- Release Notes for V19.3
- Release Notes for V19.2
- Release Notes for V19.1
- Show all articles ( 2 ) 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 Services - Overview & Capabilities
- Email Builder - User Guide
- Email - Deployment Checklist & Best Practices
- Omeda - Getting Support
- Email - Advanced Features
- Email - A/B Testing
- Email - Appending Lists On Triggered Deployments
- Email - Assigning Link Tracking Categories
- Email - Automated ACS Notifications
- Email - Deliverability
- Email - Dynamic Content
- Email - FAQs
- 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
- Email - Automation for Email Sending
- Show all articles ( 18 ) 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)
- Form Builder - Export 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
- Form Builder - Using Campaign Promo Codes
-
-
-
- Knowledge Base Home
- Documentation
- API & Webservices
- Email - Checklist for Sends Created via API Calls
Print
Email – Checklist for Sends Created via API Calls
- Create the deployment
- API call returns a TrackId that will be needed for subsequent calls.
- API call returns a TrackId that will be needed for subsequent calls.
- Add an audience to the Deployment
- This API kicks off the loading of an Audience Builder Query to a deployment. This loading generally takes anywhere from 5-30 seconds. This API call will return immediately, and in the response will be ListId and ListUrl fields. The client will then use that ListURL to poll the Email Audience Assignment Status API (#3 next).
- *** the actual query name will be provided by your Audience Director. Please reach out to your Account Manager if assistance is needed.
- Email Audience Status API (poll every 5 or 10 seconds until audience has been fully assigned)
- Use the ListUrl from the Email Deployment Add Audience API and query the API until the AssignmentStatusCode field in the response json is either DONE or WARNING. Please be sure that your tool considers WARNING as a successful status. Often, the API will return a WARNING status if there are a few emails that were deemed invalid or incorrectly formatted.
- Use the ListUrl from the Email Deployment Add Audience API and query the API until the AssignmentStatusCode field in the response json is either DONE or WARNING. Please be sure that your tool considers WARNING as a successful status. Often, the API will return a WARNING status if there are a few emails that were deemed invalid or incorrectly formatted.
- Email Deployment Content API
- Note that this particular API only accepts XML.
- Please note in the examples how we wrap the various fields inside cdata nodes.
- Email Deployment Test
- Sends a test deployment to those designated as testers or seeds for the deployment type.
- Testers or seeds can be passed when the deployment is created, or what is more common is that the client maintains the required test and seednames in Email Builder -> Tools -> Deployment Defaults.
- Email Deployment Schedule
- The schedule date passed in must be in the future and the time zone is always CST.
- If you read the knowledge base document, you can see that you can pass in [NOW] as the scheduled date if you wish for the deployment to go out immediately.
- Deployment Unschedule API
- If you find you need to cancel your deployment, the Deployment Unschedule API is available.
Table of Contents