Email Deployment Test
- Bettina Lippisch
Summary
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. Test recipients are optional and can be added to a deployment via the Deployment Api. A Deployment Test Resource api call is required before Scheduling a deployment.
An HTTP POST request is used to send a test.
Base Resource URI
For Production, use: https://ows.omeda.com/webservices/rest/brand/{brandAbbreviation}/omail/deployment/sendtest/*
For Testing, use: https://ows.omedastaging.com/webservices/rest/brand/{brandAbbreviation}/omail/deployment/sendtest/*
brandAbbreviation is the abbreviation for the brand to which the data is being posted.
Technical Requirements
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 a content type supported by this resource. See Supported Content Types for more details. If omitted, the default content type is application/json.
Optional header element:
Supported Content Types
If omitted, the default content type is application/json. JSON application/json
JSON is the preferred data exchange format, because it is lightweight and, in most cases, faster to process and utilizes less bandwidth. There are many available open-source JSON libraries available. See json.org for details.
Supported HTTP Methods
There is one HTTP method supported: POST See W3C’s POST specs for details.
POST method is used when creating a new deployment.
Field Definition
The following tables describe the hierarchical data elements.
Deployment Test Elements
Attribute Name | Required? | Data Type | Description |
|---|---|---|---|
UserId | required | string | UserId of the active omail account authorized for this deployment. This is generally the ‘OwnerUserId’ specified in the Deployment Api |
TrackId | required | string | The TrackId for the deployment. |
POST JSON Request Example: When sending deployment tests
{
"UserId": "omailaccount1",
"TrackId": "FOO020300219"
}
Response Examples
Responses possible: a successful POST (200 OK Status) or a failed POST(400 Bad Request/403 Forbidden/404 Not Found/405 Method Not Allowed Statuses). See W3C’s Status Codes.
Successful Submission
A successful POST submission will send test copies of the specified deployment to the deployment test recipients. The response object will contain the TrackId of the deployment, a unique ‘SubmissionId’, and a url to call the Deployment Lookup API for this deployment.
Status | Description |
|---|---|
200 OK | Please be sure to check the response json for warnings. A typical warning would be that your content has no unsubscribe link. |
JSON Example
{
"ResponseInfo":[
{
"SubmissionId" : "C95AE90C-BEC6-41F2-91E2-2BA9168D1D1E",
"TrackId":"FOO0200300112",
"Url":"https://ows.omedastaging.com/webservices/rest/brand/FOO/omail/deployment/lookup/FOO0200300112/*",
"Warnings" : ["Warning" : "Missing Unsubscribe Link for split 1 in HTML"}]
}
]
}
Failed Submission
Potential errors:
A failed POST submission may be due to several factors:
Status | Description |
|---|---|
400 Bad Request | Typically, this error occurs when the deployment content is invalid. See potential errors for details. |
403 Forbidden | Typically, this error occurs when the credentials are erroneous. Potentially, an incorrect x-omeda-appid. |
404 Not Found | Typically, this error occurs with a malformed URL or the resource that is searched for is not found. This can occur if a TrackId submitted is not found in our system. |
405 Method Not Allowed | Typically, this error occurs when the resource accessed is not allowed by the HTTP Method utilized. Make sure you employ the correct HTTP Method (POST) for this request. |
This is not an exhaustive list of errors, but common ones. If an error occurs repeatedly, please contact your Omeda representative.
JSON Example
Table of Contents