Email Builder APIs

Email Builder APIs

Knowledge Base Home

Search the Omeda Knowledge Base

Email Audience Assignment Status

The List Assignment Status API provides the ability to get the status of a customer list that is currently being assigned from the Omail FTP Site to a deployment.

Email Clicks

This service retrieves Omail data related to clicks on links in emails using various parameters.

Email Deployment

The Deployment Service API provides the ability to post/put deployment information to Email Builder. This information is used to either create a new Email Builder deployment, or update an existing Email Builder deployment. Deployment information is validated for basic information.

Email Deployment Add Audience

The Deployment Add Audience API provides the ability add a previously uploaded list of customers to a deployment.

Email Deployment Approval Lookup

The Deployment Approval Lookup API provides the ability to retrieve the approval queue information such as tests, users and comments.

Email Deployment Audience List FTP

Deployment List FTP is the means by which deployment lists are made available in the Email Builder system.

Email Deployment Cancel

The Deployment Cancel API provides the ability to cancel a deployment.

Email Deployment Clone

The Clone Deployment Service API provides the ability to post deployment information to Omail. This information is used to clone existing Omail deployment. Deployment information is validated for basic information.

Email Deployment Content

The Deployment Content API provides the ability to post information to a deployment. These fields can include the ‘Subject’ line of the email, the ‘From Name’ of the email, the HTML content, the Text content, etc. Since we are passing in html data in this resource, xml is the default format for requests and responses.

Email Deployment Content Lookup

An api available to our Email Builder clients. For a given set of url parameters – the API will return the text or html content for a given Email Builder deployment and specified split.

Email Deployment Lookup

The Deployment Lookup API provides the ability to retrieve deployment information such as link tracking, delivery statistics, deployment status, history, etc. via an HTTP GET request.

Email Deployment Remove Audience

The Deployment Remove Audience API provides the ability to remove a list that is currently assigned to a deployment.

Email Deployment Schedule

The Deployment Schedule API provides the ability to schedule a deployment for sending.

Email Deployment Search

This service retrieves a list of most recent deployments for a given brand based on search parameters.

Email Deployment Test

The Deployment Test API provides the ability to send test copies of your deployment to the test recipients that were specified when the deployment was created.

Email Deployment Unschedule

The Deployment Unschedule API provides the ability to unschedule a deployment, perhaps to allow further editing.

Email Flag Email As Invalid

The Invalid Email API allows our client to mark a customer Email Address as invalid for a brand.

Email On Demand Send

The Deployment API allows our clients to send a single Omail email deployment.

Email Opt In/Out Lookup

This service returns Opt In/Out information stored for a given customer.

Email Optin Queue

The OptIn Queue API allows our client to OptIn their subscribers or customers to their email deployments at the client, brand, and deployment type level. All 3 OptIn levels can be submitted in one OptIn Queue API call.

Email Optout Queue

The OptOut Queue API allows our client to OptOut their subscribers or customers to their email deployments at the client, brand, and deployment type level. All 3 OptOut levels can be submitted in one OptOut Queue API call.

Email – Checklist for Sends Created via API Calls

Checklist for Sends Created via API Calls.