Email Deployment

TrackId

conditional

string

If the user wishes to update an existing deployment. They are required to make a HTTP PUT request along with a TrackId for an existing deployment. For a new deployment, the user uses a POST request and should not submit a TrackId.

DeploymentName

conditional

string

The name designated for the deployment. Max Characters: 80. Required for Create call, optional for Update call.

DeploymentDate

conditional

date

The tentative date the deployment will be sent. Format: ‘yyyy-MM-dd HH:mm’. The date must be in the future. Required for Create call, optional for Update call.

DeploymentTypeId

conditional

integer

The Deployment Type Identifier in the Omail system. The Brand Lookup API can be used to retrieve valid values for this field. Required for Create call, optional for Update call.

OwnerUserId

required

string

The User ID of an active Omail account to be designated as the ‘owner’. The owner is generally the account that will be working on the deployment throughout the creation and sending process.

CampaignId

optional

string

An optional Campaign Id to assign to the deployment. Max Characters: 100.

Splits

conditional

integer

The number of splits the deployment has. Each split will have its own designated email information such as html content, text content, from name, mailbox, email subject, etc. Required for Create call, optional for Update call.

TrackOpens

required

byte

1 = Track and store the opening of HTML emails. 0 = do not track and store the opening of HTML emails.

TrackLinks

required

byte

1 = Track and store link clicks on the deployment. 0 = do not track and store link clicks on the deployment.

Testers

optional

array

An array of json objects. Each object contains deployment tester information: First Name, Last Name, and Email Address.

FinalApproverUserId

optional

string

The User ID of an active Omail account to be designated as the ‘final approver’. If final approver is not specified, it will be defaulted to the OwnerUserID.

Notes

optional

string

Optional user-specified notes regarding the deployment.

ReloadOnqQueryBeforeFinalDeployment

optional

byte

1 = If deployment audience is from an onq query, then re-execute the query before final deployment time. 0 = do not re-execute onq query before deployment time (if applicable).

BillingCategoryCode

optional

string

Optional 8 characters billing category. It must be already defined in Omail before it can be used in API call.

UseContentRecommendation

optional

byte

1 = Use Content Recommendations, 0 = Do not use content recommendations. If it is not specified, it will be defaulted to 0.

ContentRecommendationBehaviorId

conditional

integer

The Behavior identifier in the Omeda system. Required if UseContentRecommendation = 1

UseImagesInRecommendation

conditional

byte

1 = Use Images in Content Recommendations, 0 = Do not use Images in Content Recommendations. Required if UseContentRecommendation = 1

NumberOfRecommendations

conditional

integer

Valid values are 1 – 10. Required if UseContentRecommendation = 1

FirstName

required

string

The first name of the tester. Max Characters: 80.

LastName

required

string

The last name of the tester. Max Characters: 80.

EmailAddress

required

string

The email address of the tester. Max Characters: 255.

400 Bad Request

Typically, this error occurs when the request does not follow the specifications. In the case of an update, this can occur if an HTTP PUT request is submitted without a TrackId element in the submitted json data.

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.