Email Deployment Clone

Summary

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.

An HTTP POST request is used to clone existing deployment. The TrackId of the deployment to clone must be included in the request JSON.

Base Resource URI

For Production, use: https://ows.omeda.com/webservices/rest/brand/{brandAbbreviation}/omail/deployment/clone/*

For Testing, use: https://ows.omedastaging.com/webservices/rest/brand/{brandAbbreviation}/omail/deployment/clone*

brandAbbreviationis the abbreviation for the brand to which the data is being posted.

Please note: When migrating from the testing environment to the production environment, deployments created or updated in the testing environment will not be available in the production environment. You will need to create new deployments and for this reason should not hard code any deployment tracking numbers in your code.

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-typea content type supported by this resource. See Supported Content Types for more details. If omitted, the default content type is application/json.

Supported Content Types

If omitted, the default content type is application/json.JSONapplication/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:POSTSee 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.

• Any optional attributes if not specified – retain their values from cloned deployment unless otherwise stated in description.

Deployment Elements

Testers Elements

POST JSON Request Example: cloning deployment

{
    “CloneTrackId" : "FOO0200300112",
    "DeploymentName": "Test Warmup - #2",
    "DeploymentDate": "2012-02-29 13:45",
    "CampaignId": "Campaign2",
    "OwnerUserId": "omailuser1",
    "Notes": "Don't send until Mar. 30th."
}

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 POST Submission

A successful POST submission will clone specified existing deployment and create an Omail deployment shell with the designated information from the request body. A successful POST request will return a Url that can be used to retrieve deployment information such as link tracking, delivery statistics, deployment status, history, etc. (See Deployment Lookup Resource).

JSON Example

{
  "ResponseInfo":[
    {
      "SubmissionId" : "C95AE90C-BEC6-41F2-91E2-2BA9168D1D1E",
      "TrackId":"FOO0200300112",
      "Url":"https://ows.omedastaging.com/webservices/rest/brand/FOO/omail/deployment/lookup/FOO0200300112/*"
    }
  ]
}

Failed Submission

Potential errors:

The value '{stringField}' for field '{fieldName}' exceeded a max length of {maximumAllowed}.
'OwnerUserId' {ownerUserId} is not active.
'FinalApproverUserId' {finalApproverUserId} is not active.
'{RequiredFieldName}' is a required field.
The Duplicate value '{emailAddress}' submitted for Testers array, field 'EmailAddress'. Tester emails must be unique.
The value '{trackLinks}' for field 'TrackLinks' must be 0 or 1.
The value '{trackOpens}' for field 'TrackOpens' must be 0 or 1.
'CloneTrackId' is a required field.
No deployment was found matching trackId '{trackId}'.
Deployment '{trackId}' cannot be cloned.
OwnerUserId '{ownerUserId}' is not authorized to edit deployment '{trackId}'"
Invalid value '{deploymentDate}' for field 'DeploymentDate'. The date must be in the future.
Invalid value '{deploymentDate}' for field 'DeploymentDate'. Date format yyyy-MM-dd HH:mm is required.

A failed POST submission may be due to several factors:

This is not an exhaustive list of errors, but common ones. If an error occurs repeatedly, please contact your Omeda representative.

JSON Example

{
  "SubmissionId" : "C95AE90C-BEC6-41F2-91E2-2BA9168D1D1F",
  "Errors" : [
    {
      Error": "A 'CloneTrackId' element is required." 
    },
    {
      "Error": "' DeploymentDate' is a required field."
    }
  ]
}