For more information on using API
POST https://webapi.mymarketing.co.il/api/templates/{Id}/campaign
Create campaign using a specific template
Request Information
URI Parameters
Name
Description
Type
Additional information
Id
Template id. Can be found using the endpoint "Get account's "my templates"" or in the UI(go to "Emails" -> "My Templates" -> click on your desired template -> you'll find the ID at the end of the URL).
integer
Required
Body Parameters
Name
Description
Type
Additional information
campaign_details
The details of the campaign that you create: name, campaign subject, sending profile id, google analytics, campaign category id, sub account id and preheader.
pairs
can be used whether you chose to use the "content" or "template" parameters. The KEY can be any value (text type) you want. If the value is found in the template/content, it will be replaced with the corresponding VALUE. please note: if you send the email to a number of emails at the same time - the key and value cannot be personalized to each costumer
Collection of Pair
Request Formats
application/json, text/json
Sample:
{
"campaign_details": {
"name": "sample string 1",
"subject": "sample string 2",
"user_profile_id": 1,
"google_analytics_name": "sample string 3",
"content_category_id": 1,
"preheader": "sample string 4",
"predictive_delivery": true
},
"pairs": [
{
"Key": {},
"Value": {}
},
{
"Key": {},
"Value": {}
}
]
}
application/xml, text/xml
Sample:
<ApiCampaignPostInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">
<campaign_details>
<add_statistics i:nil="true" />
<content_category_id>1</content_category_id>
<google_analytics_name>sample string 3</google_analytics_name>
<name>sample string 1</name>
<predictive_delivery>true</predictive_delivery>
<preheader>sample string 4</preheader>
<segmentation_id>1</segmentation_id>
<sub_account_id>1</sub_account_id>
<subject>sample string 2</subject>
<user_profile_id>1</user_profile_id>
</campaign_details>
<pairs xmlns:d2p1="http://schemas.datacontract.org/2004/07/ActiveTrail.Framework">
<d2p1:Pair>
<d2p1:_key />
<d2p1:_value />
</d2p1:Pair>
<d2p1:Pair>
<d2p1:_key />
<d2p1:_value />
</d2p1:Pair>
</pairs>
</ApiCampaignPostInfo>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Name
Description
Type
Additional information
id
Campaign id
integer
send_test
Email addresses you'd like to send a test email, should be separated by comma(,).
string
Response Formats
application/json, text/json
Sample:
{
"id": 1,
"send_type": "Empty",
"send_test": "sample string 2",
"details": {
"name": "sample string 1",
"subject": "sample string 2",
"user_profile_id": 1,
"google_analytics_name": "sample string 3",
"content_category_id": 1,
"preheader": "sample string 4",
"predictive_delivery": true
},
"design": {
"content": "sample string 1",
"language_type": "IBM_EBCDIC_US_Canada",
"header_footer_language_type": "IBM_EBCDIC_US_Canada",
"is_add_print_email": true,
"is_auto_css_inliner": true,
"is_remove_system_links": false
},
"template": {
"id": 1
},
"a_b_settings": {
"scheduling": {
"is_sent": true,
"scheduled_date_utc": "2016-12-24T14:12:12"
},
"subject": "sample string 1",
"user_profile_id": 1,
"google_analytics_name": "sample string 2",
"ab_percent_split_groups": 3.1,
"wait_time": {
"interval_type": "Hour",
"interval_time": 1
},
"winning_version_by": "Highest_ClickThrough_Rate",
"design": {
"content": "sample string 1",
"language_type": "IBM_EBCDIC_US_Canada",
"header_footer_language_type": "IBM_EBCDIC_US_Canada",
"is_add_print_email": true,
"is_auto_css_inliner": true,
"is_remove_system_links": false
}
},
"carts": {
"ecommerce_data": [
{
"products": {
"object_url": "sample string 1",
"total": {
"amount": 1.1,
"currency": "sample string 2"
},
"total_discount": {
"amount": 1.1,
"currency": "sample string 2"
},
"shipping": {
"amount": 1.1,
"currency": "sample string 2"
},
"coupon": {
"code": "sample string 1",
"amount": {
"amount": 1.1,
"currency": "sample string 2"
}
},
"items": [
{
"product": {
"id": 1,
"real_price": {
"amount": 1.1,
"currency": "sample string 2"
},
"new_price": {
"amount": 1.1,
"currency": "sample string 2"
},
"title": "sample string 2",
"description": "sample string 3",
"additional_txt_1": "sample string 4",
"additional_txt_2": "sample string 5",
"sku": "sample string 6",
"thumbnail_url": "sample string 7",
"add_to_cart_url": "sample string 8",
"product_page_url": "sample string 9",
"tags": "sample string 10"
},
"quantity": 1,
"total_price": {
"amount": 1.1,
"currency": "sample string 2"
}
},
{
"product": {
"id": 1,
"real_price": {
"amount": 1.1,
"currency": "sample string 2"
},
"new_price": {
"amount": 1.1,
"currency": "sample string 2"
},
"title": "sample string 2",
"description": "sample string 3",
"additional_txt_1": "sample string 4",
"additional_txt_2": "sample string 5",
"sku": "sample string 6",
"thumbnail_url": "sample string 7",
"add_to_cart_url": "sample string 8",
"product_page_url": "sample string 9",
"tags": "sample string 10"
},
"quantity": 1,
"total_price": {
"amount": 1.1,
"currency": "sample string 2"
}
}
],
"status": {
"name": "sample string 1",
"code": "sample string 2"
},
"created_on": "2016-12-24T14:12:12",
"modified_on": "2016-12-24T14:12:12",
"order_id": "sample string 2"
},
"recommendations": {
"items": [
{
"product": {
"id": 1,
"real_price": {
"amount": 1.1,
"currency": "sample string 2"
},
"new_price": {
"amount": 1.1,
"currency": "sample string 2"
},
"title": "sample string 2",
"description": "sample string 3",
"additional_txt_1": "sample string 4",
"additional_txt_2": "sample string 5",
"sku": "sample string 6",
"thumbnail_url": "sample string 7",
"add_to_cart_url": "sample string 8",
"product_page_url": "sample string 9",
"tags": "sample string 10"
},
"quantity": 1,
"total_price": {
"amount": 1.1,
"currency": "sample string 2"
}
},
{
"product": {
"id": 1,
"real_price": {
"amount": 1.1,
"currency": "sample string 2"
},
"new_price": {
"amount": 1.1,
"currency": "sample string 2"
},
"title": "sample string 2",
"description": "sample string 3",
"additional_txt_1": "sample string 4",
"additional_txt_2": "sample string 5",
"sku": "sample string 6",
"thumbnail_url": "sample string 7",
"add_to_cart_url": "sample string 8",
"product_page_url": "sample string 9",
"tags": "sample string 10"
},
"quantity": 1,
"total_price": {
"amount": 1.1,
"currency": "sample string 2"
}
}
]
}
},
{
"products": {
"object_url": "sample string 1",
"total": {
"amount": 1.1,
"currency": "sample string 2"
},
"total_discount": {
"amount": 1.1,
"currency": "sample string 2"
},
"shipping": {
"amount": 1.1,
"currency": "sample string 2"
},
"coupon": {
"code": "sample string 1",
"amount": {
"amount": 1.1,
"currency": "sample string 2"
}
},
"items": [
{
"product": {
"id": 1,
"real_price": {
"amount": 1.1,
"currency": "sample string 2"
},
"new_price": {
"amount": 1.1,
"currency": "sample string 2"
},
"title": "sample string 2",
"description": "sample string 3",
"additional_txt_1": "sample string 4",
"additional_txt_2": "sample string 5",
"sku": "sample string 6",
"thumbnail_url": "sample string 7",
"add_to_cart_url": "sample string 8",
"product_page_url": "sample string 9",
"tags": "sample string 10"
},
"quantity": 1,
"total_price": {
"amount": 1.1,
"currency": "sample string 2"
}
},
{
"product": {
"id": 1,
"real_price": {
"amount": 1.1,
"currency": "sample string 2"
},
"new_price": {
"amount": 1.1,
"currency": "sample string 2"
},
"title": "sample string 2",
"description": "sample string 3",
"additional_txt_1": "sample string 4",
"additional_txt_2": "sample string 5",
"sku": "sample string 6",
"thumbnail_url": "sample string 7",
"add_to_cart_url": "sample string 8",
"product_page_url": "sample string 9",
"tags": "sample string 10"
},
"quantity": 1,
"total_price": {
"amount": 1.1,
"currency": "sample string 2"
}
}
],
"status": {
"name": "sample string 1",
"code": "sample string 2"
},
"created_on": "2016-12-24T14:12:12",
"modified_on": "2016-12-24T14:12:12",
"order_id": "sample string 2"
},
"recommendations": {
"items": [
{
"product": {
"id": 1,
"real_price": {
"amount": 1.1,
"currency": "sample string 2"
},
"new_price": {
"amount": 1.1,
"currency": "sample string 2"
},
"title": "sample string 2",
"description": "sample string 3",
"additional_txt_1": "sample string 4",
"additional_txt_2": "sample string 5",
"sku": "sample string 6",
"thumbnail_url": "sample string 7",
"add_to_cart_url": "sample string 8",
"product_page_url": "sample string 9",
"tags": "sample string 10"
},
"quantity": 1,
"total_price": {
"amount": 1.1,
"currency": "sample string 2"
}
},
{
"product": {
"id": 1,
"real_price": {
"amount": 1.1,
"currency": "sample string 2"
},
"new_price": {
"amount": 1.1,
"currency": "sample string 2"
},
"title": "sample string 2",
"description": "sample string 3",
"additional_txt_1": "sample string 4",
"additional_txt_2": "sample string 5",
"sku": "sample string 6",
"thumbnail_url": "sample string 7",
"add_to_cart_url": "sample string 8",
"product_page_url": "sample string 9",
"tags": "sample string 10"
},
"quantity": 1,
"total_price": {
"amount": 1.1,
"currency": "sample string 2"
}
}
]
}
}
]
},
"pairs": [
{
"Key": {},
"Value": {}
},
{
"Key": {},
"Value": {}
}
]
}
application/xml, text/xml
Sample:
<ApiCampaignInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">
<a_b_settings>
<ab_percent_split_groups>3.1</ab_percent_split_groups>
<design>
<content>sample string 1</content>
<header_footer_language_type>IBM_EBCDIC_US_Canada</header_footer_language_type>
<is_add_print_email>true</is_add_print_email>
<is_auto_css_inliner>true</is_auto_css_inliner>
<is_remove_system_links>false</is_remove_system_links>
<language_type>IBM_EBCDIC_US_Canada</language_type>
</design>
<google_analytics_name>sample string 2</google_analytics_name>
<scheduling>
<is_limit_to_confirmed>true</is_limit_to_confirmed>
<is_sent>true</is_sent>
<scheduled_date_utc>2016-12-24T14:12:12</scheduled_date_utc>
</scheduling>
<subject>sample string 1</subject>
<user_profile_id>1</user_profile_id>
<wait_time>
<interval_time>1</interval_time>
<interval_type>Hour</interval_type>
</wait_time>
<winning_version_by>Highest_ClickThrough_Rate</winning_version_by>
</a_b_settings>
<carts>
<ecommerce_data>
<ApiEcommerceData>
<products>
<coupon>
<amount>
<amount>1.1</amount>
<currency>sample string 2</currency>
</amount>
<code>sample string 1</code>
</coupon>
<created_on>2016-12-24T14:12:12</created_on>
<items>
<ApiItem>
<product>
<add_to_cart_url>sample string 8</add_to_cart_url>
<additional_txt_1>sample string 4</additional_txt_1>
<additional_txt_2>sample string 5</additional_txt_2>
<description>sample string 3</description>
<id>1</id>
<new_price>
<amount>1.1</amount>
<currency>sample string 2</currency>
</new_price>
<product_page_url>sample string 9</product_page_url>
<real_price>
<amount>1.1</amount>
<currency>sample string 2</currency>
</real_price>
<sku>sample string 6</sku>
<tags>sample string 10</tags>
<thumbnail_url>sample string 7</thumbnail_url>
<title>sample string 2</title>
</product>
<quantity>1</quantity>
<total_price>
<amount>1.1</amount>
<currency>sample string 2</currency>
</total_price>
</ApiItem>
<ApiItem>
<product>
<add_to_cart_url>sample string 8</add_to_cart_url>
<additional_txt_1>sample string 4</additional_txt_1>
<additional_txt_2>sample string 5</additional_txt_2>
<description>sample string 3</description>
<id>1</id>
<new_price>
<amount>1.1</amount>
<currency>sample string 2</currency>
</new_price>
<product_page_url>sample string 9</product_page_url>
<real_price>
<amount>1.1</amount>
<currency>sample string 2</currency>
</real_price>
<sku>sample string 6</sku>
<tags>sample string 10</tags>
<thumbnail_url>sample string 7</thumbnail_url>
<title>sample string 2</title>
</product>
<quantity>1</quantity>
<total_price>
<amount>1.1</amount>
<currency>sample string 2</currency>
</total_price>
</ApiItem>
</items>
<modified_on>2016-12-24T14:12:12</modified_on>
<object_url>sample string 1</object_url>
<order_id>sample string 2</order_id>
<shipping>
<amount>1.1</amount>
<currency>sample string 2</currency>
</shipping>
<status>
<code>sample string 2</code>
<name>sample string 1</name>
</status>
<total>
<amount>1.1</amount>
<currency>sample string 2</currency>
</total>
<total_discount>
<amount>1.1</amount>
<currency>sample string 2</currency>
</total_discount>
</products>
<recommendations>
<items>
<ApiItem>
<product>
<add_to_cart_url>sample string 8</add_to_cart_url>
<additional_txt_1>sample string 4</additional_txt_1>
<additional_txt_2>sample string 5</additional_txt_2>
<description>sample string 3</description>
<id>1</id>
<new_price>
<amount>1.1</amount>
<currency>sample string 2</currency>
</new_price>
<product_page_url>sample string 9</product_page_url>
<real_price>
<amount>1.1</amount>
<currency>sample string 2</currency>
</real_price>
<sku>sample string 6</sku>
<tags>sample string 10</tags>
<thumbnail_url>sample string 7</thumbnail_url>
<title>sample string 2</title>
</product>
<quantity>1</quantity>
<total_price>
<amount>1.1</amount>
<currency>sample string 2</currency>
</total_price>
</ApiItem>
<ApiItem>
<product>
<add_to_cart_url>sample string 8</add_to_cart_url>
<additional_txt_1>sample string 4</additional_txt_1>
<additional_txt_2>sample string 5</additional_txt_2>
<description>sample string 3</description>
<id>1</id>
<new_price>
<amount>1.1</amount>
<currency>sample string 2</currency>
</new_price>
<product_page_url>sample string 9</product_page_url>
<real_price>
<amount>1.1</amount>
<currency>sample string 2</currency>
</real_price>
<sku>sample string 6</sku>
<tags>sample string 10</tags>
<thumbnail_url>sample string 7</thumbnail_url>
<title>sample string 2</title>
</product>
<quantity>1</quantity>
<total_price>
<amount>1.1</amount>
<currency>sample string 2</currency>
</total_price>
</ApiItem>
</items>
</recommendations>
</ApiEcommerceData>
<ApiEcommerceData>
<products>
<coupon>
<amount>
<amount>1.1</amount>
<currency>sample string 2</currency>
</amount>
<code>sample string 1</code>
</coupon>
<created_on>2016-12-24T14:12:12</created_on>
<items>
<ApiItem>
<product>
<add_to_cart_url>sample string 8</add_to_cart_url>
<additional_txt_1>sample string 4</additional_txt_1>
<additional_txt_2>sample string 5</additional_txt_2>
<description>sample string 3</description>
<id>1</id>
<new_price>
<amount>1.1</amount>
<currency>sample string 2</currency>
</new_price>
<product_page_url>sample string 9</product_page_url>
<real_price>
<amount>1.1</amount>
<currency>sample string 2</currency>
</real_price>
<sku>sample string 6</sku>
<tags>sample string 10</tags>
<thumbnail_url>sample string 7</thumbnail_url>
<title>sample string 2</title>
</product>
<quantity>1</quantity>
<total_price>
<amount>1.1</amount>
<currency>sample string 2</currency>
</total_price>
</ApiItem>
<ApiItem>
<product>
<add_to_cart_url>sample string 8</add_to_cart_url>
<additional_txt_1>sample string 4</additional_txt_1>
<additional_txt_2>sample string 5</additional_txt_2>
<description>sample string 3</description>
<id>1</id>
<new_price>
<amount>1.1</amount>
<currency>sample string 2</currency>
</new_price>
<product_page_url>sample string 9</product_page_url>
<real_price>
<amount>1.1</amount>
<currency>sample string 2</currency>
</real_price>
<sku>sample string 6</sku>
<tags>sample string 10</tags>
<thumbnail_url>sample string 7</thumbnail_url>
<title>sample string 2</title>
</product>
<quantity>1</quantity>
<total_price>
<amount>1.1</amount>
<currency>sample string 2</currency>
</total_price>
</ApiItem>
</items>
<modified_on>2016-12-24T14:12:12</modified_on>
<object_url>sample string 1</object_url>
<order_id>sample string 2</order_id>
<shipping>
<amount>1.1</amount>
<currency>sample string 2</currency>
</shipping>
<status>
<code>sample string 2</code>
<name>sample string 1</name>
</status>
<total>
<amount>1.1</amount>
<currency>sample string 2</currency>
</total>
<total_discount>
<amount>1.1</amount>
<currency>sample string 2</currency>
</total_discount>
</products>
<recommendations>
<items>
<ApiItem>
<product>
<add_to_cart_url>sample string 8</add_to_cart_url>
<additional_txt_1>sample string 4</additional_txt_1>
<additional_txt_2>sample string 5</additional_txt_2>
<description>sample string 3</description>
<id>1</id>
<new_price>
<amount>1.1</amount>
<currency>sample string 2</currency>
</new_price>
<product_page_url>sample string 9</product_page_url>
<real_price>
<amount>1.1</amount>
<currency>sample string 2</currency>
</real_price>
<sku>sample string 6</sku>
<tags>sample string 10</tags>
<thumbnail_url>sample string 7</thumbnail_url>
<title>sample string 2</title>
</product>
<quantity>1</quantity>
<total_price>
<amount>1.1</amount>
<currency>sample string 2</currency>
</total_price>
</ApiItem>
<ApiItem>
<product>
<add_to_cart_url>sample string 8</add_to_cart_url>
<additional_txt_1>sample string 4</additional_txt_1>
<additional_txt_2>sample string 5</additional_txt_2>
<description>sample string 3</description>
<id>1</id>
<new_price>
<amount>1.1</amount>
<currency>sample string 2</currency>
</new_price>
<product_page_url>sample string 9</product_page_url>
<real_price>
<amount>1.1</amount>
<currency>sample string 2</currency>
</real_price>
<sku>sample string 6</sku>
<tags>sample string 10</tags>
<thumbnail_url>sample string 7</thumbnail_url>
<title>sample string 2</title>
</product>
<quantity>1</quantity>
<total_price>
<amount>1.1</amount>
<currency>sample string 2</currency>
</total_price>
</ApiItem>
</items>
</recommendations>
</ApiEcommerceData>
</ecommerce_data>
</carts>
<design>
<content>sample string 1</content>
<header_footer_language_type>IBM_EBCDIC_US_Canada</header_footer_language_type>
<is_add_print_email>true</is_add_print_email>
<is_auto_css_inliner>true</is_auto_css_inliner>
<is_remove_system_links>false</is_remove_system_links>
<language_type>IBM_EBCDIC_US_Canada</language_type>
</design>
<details>
<add_statistics i:nil="true" />
<content_category_id>1</content_category_id>
<google_analytics_name>sample string 3</google_analytics_name>
<name>sample string 1</name>
<predictive_delivery>true</predictive_delivery>
<preheader>sample string 4</preheader>
<segmentation_id>1</segmentation_id>
<sub_account_id>1</sub_account_id>
<subject>sample string 2</subject>
<user_profile_id>1</user_profile_id>
</details>
<pairs xmlns:d2p1="http://schemas.datacontract.org/2004/07/ActiveTrail.Framework">
<d2p1:Pair>
<d2p1:_key />
<d2p1:_value />
</d2p1:Pair>
<d2p1:Pair>
<d2p1:_key />
<d2p1:_value />
</d2p1:Pair>
</pairs>
<template>
<id>1</id>
</template>
<send_test>sample string 2</send_test>
<id>1</id>
<send_type>Empty</send_type>
</ApiCampaignInfo>