For more information on using API
POST http://webapi.mymarketing.co.il/api/OperationalMessage/Contacts
Send an email operational message to individual contacts (limited to 500 messages). The contacts will be created in your account.
Request Information
URI Parameters
Body Parameters
Name
Description
Type
Additional information
ContactPackage
Email address with collection of pairs of keys and values per each email. Please note, personalized fields would work in this endpoint only if you add them as information in the endpoint
Collection of ApiContactPackage
Request Formats
application/json, text/json
Sample:
{
"contact_package": [
{
"contact": {
"email": "sample string 7",
"sms": "sample string 8",
"first_name": "sample string 9",
"last_name": "sample string 10",
"anniversary": "2016-12-24T14:12:12",
"birthday": "2016-12-24T14:12:12",
"city": "sample string 11",
"fax": "sample string 12",
"phone1": "sample string 13",
"phone2": "sample string 14",
"street": "sample string 15",
"zip_code": "sample string 16",
"ext1": "sample string 17",
"ext2": "sample string 18",
"ext3": "sample string 19",
"ext4": "sample string 20",
"ext5": "sample string 21",
"ext6": "sample string 22",
"ext7": "sample string 23",
"ext8": "sample string 24",
"ext9": "sample string 25",
"ext10": "sample string 26",
"ext11": "sample string 27",
"ext12": "sample string 28",
"ext13": "sample string 29",
"ext14": "sample string 30",
"ext15": "sample string 31",
"ext16": "sample string 32",
"ext17": "sample string 33",
"ext18": "sample string 34",
"ext19": "sample string 35",
"ext20": "sample string 36",
"ext21": "sample string 37",
"ext22": "sample string 38",
"ext23": "sample string 39",
"ext24": "sample string 40",
"ext25": "sample string 41",
"date1": "2016-12-24T14:12:12",
"date2": "2016-12-24T14:12:12",
"date3": "2016-12-24T14:12:12",
"date4": "2016-12-24T14:12:12",
"date5": "2016-12-24T14:12:12",
"num1": 1,
"num2": 1,
"num3": 1,
"num4": 1,
"num5": 1,
"is_deleted": true
},
"pairs": [
{
"key": "sample string 1",
"value": "sample string 2"
},
{
"key": "sample string 1",
"value": "sample string 2"
}
]
},
{
"contact": {
"email": "sample string 7",
"sms": "sample string 8",
"first_name": "sample string 9",
"last_name": "sample string 10",
"anniversary": "2016-12-24T14:12:12",
"birthday": "2016-12-24T14:12:12",
"city": "sample string 11",
"fax": "sample string 12",
"phone1": "sample string 13",
"phone2": "sample string 14",
"street": "sample string 15",
"zip_code": "sample string 16",
"ext1": "sample string 17",
"ext2": "sample string 18",
"ext3": "sample string 19",
"ext4": "sample string 20",
"ext5": "sample string 21",
"ext6": "sample string 22",
"ext7": "sample string 23",
"ext8": "sample string 24",
"ext9": "sample string 25",
"ext10": "sample string 26",
"ext11": "sample string 27",
"ext12": "sample string 28",
"ext13": "sample string 29",
"ext14": "sample string 30",
"ext15": "sample string 31",
"ext16": "sample string 32",
"ext17": "sample string 33",
"ext18": "sample string 34",
"ext19": "sample string 35",
"ext20": "sample string 36",
"ext21": "sample string 37",
"ext22": "sample string 38",
"ext23": "sample string 39",
"ext24": "sample string 40",
"ext25": "sample string 41",
"date1": "2016-12-24T14:12:12",
"date2": "2016-12-24T14:12:12",
"date3": "2016-12-24T14:12:12",
"date4": "2016-12-24T14:12:12",
"date5": "2016-12-24T14:12:12",
"num1": 1,
"num2": 1,
"num3": 1,
"num4": 1,
"num5": 1,
"is_deleted": true
},
"pairs": [
{
"key": "sample string 1",
"value": "sample string 2"
},
{
"key": "sample string 1",
"value": "sample string 2"
}
]
}
],
"details": {
"name": "sample string 1",
"subject": "sample string 2",
"user_profile_id": 1,
"classification": "sample string 3",
"user_profile_fromname": "sample string 4"
},
"design": {
"content": "sample string 1",
"language_type": "IBM_EBCDIC_US_Canada",
"body_part_format": 1,
"add_print_button": true,
"template_id": 3,
"add_Statistics": true
},
"bcc": {
"bcc_emails": [
"sample string 1",
"sample string 2"
]
}
}
application/xml, text/xml
Sample:
<ApiMessageContact xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Details>
<Name>sample string 1</Name>
<Subject>sample string 2</Subject>
<UserProfileId>1</UserProfileId>
<Classification>sample string 3</Classification>
<UserProfileFromName>sample string 4</UserProfileFromName>
</Details>
<Design>
<Content>sample string 1</Content>
<LanguageType>IBM_EBCDIC_US_Canada</LanguageType>
<BodyPartFormat>HTML</BodyPartFormat>
<AddPrintButton>true</AddPrintButton>
<TemplateId>3</TemplateId>
<AddStatistics>true</AddStatistics>
</Design>
<BCC>
<BCCEmails>
<string>sample string 1</string>
<string>sample string 2</string>
</BCCEmails>
</BCC>
<ContactPackage>
<ApiContactPackage>
<Contact>
<Id>1</Id>
<Email>sample string 7</Email>
<SMS>sample string 8</SMS>
<FirstName>sample string 9</FirstName>
<LastName>sample string 10</LastName>
<Anniversary>2016-12-24T14:12:12</Anniversary>
<Birthday>2016-12-24T14:12:12</Birthday>
<City>sample string 11</City>
<Fax>sample string 12</Fax>
<Phone1>sample string 13</Phone1>
<Phone2>sample string 14</Phone2>
<Street>sample string 15</Street>
<ZipCode>sample string 16</ZipCode>
<Ext1>sample string 17</Ext1>
<Ext2>sample string 18</Ext2>
<Ext3>sample string 19</Ext3>
<Ext4>sample string 20</Ext4>
<Ext5>sample string 21</Ext5>
<Ext6>sample string 22</Ext6>
<Ext7>sample string 23</Ext7>
<Ext8>sample string 24</Ext8>
<Ext9>sample string 25</Ext9>
<Ext10>sample string 26</Ext10>
<Ext11>sample string 27</Ext11>
<Ext12>sample string 28</Ext12>
<Ext13>sample string 29</Ext13>
<Ext14>sample string 30</Ext14>
<Ext15>sample string 31</Ext15>
<Ext16>sample string 32</Ext16>
<Ext17>sample string 33</Ext17>
<Ext18>sample string 34</Ext18>
<Ext19>sample string 35</Ext19>
<Ext20>sample string 36</Ext20>
<Ext21>sample string 37</Ext21>
<Ext22>sample string 38</Ext22>
<Ext23>sample string 39</Ext23>
<Ext24>sample string 40</Ext24>
<Ext25>sample string 41</Ext25>
<Date1>2016-12-24T14:12:12</Date1>
<Date2>2016-12-24T14:12:12</Date2>
<Date3>2016-12-24T14:12:12</Date3>
<Date4>2016-12-24T14:12:12</Date4>
<Date5>2016-12-24T14:12:12</Date5>
<Num1>1</Num1>
<Num2>1</Num2>
<Num3>1</Num3>
<Num4>1</Num4>
<Num5>1</Num5>
<IsDeleted>true</IsDeleted>
<IsOptined>true</IsOptined>
<SubscribeIp>sample string 2</SubscribeIp>
<status>None</status>
<sms_status>None</sms_status>
<State>Unsubscribed</State>
</Contact>
<Pair>
<ApiPair>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</ApiPair>
<ApiPair>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</ApiPair>
</Pair>
</ApiContactPackage>
<ApiContactPackage>
<Contact>
<Id>1</Id>
<Email>sample string 7</Email>
<SMS>sample string 8</SMS>
<FirstName>sample string 9</FirstName>
<LastName>sample string 10</LastName>
<Anniversary>2016-12-24T14:12:12</Anniversary>
<Birthday>2016-12-24T14:12:12</Birthday>
<City>sample string 11</City>
<Fax>sample string 12</Fax>
<Phone1>sample string 13</Phone1>
<Phone2>sample string 14</Phone2>
<Street>sample string 15</Street>
<ZipCode>sample string 16</ZipCode>
<Ext1>sample string 17</Ext1>
<Ext2>sample string 18</Ext2>
<Ext3>sample string 19</Ext3>
<Ext4>sample string 20</Ext4>
<Ext5>sample string 21</Ext5>
<Ext6>sample string 22</Ext6>
<Ext7>sample string 23</Ext7>
<Ext8>sample string 24</Ext8>
<Ext9>sample string 25</Ext9>
<Ext10>sample string 26</Ext10>
<Ext11>sample string 27</Ext11>
<Ext12>sample string 28</Ext12>
<Ext13>sample string 29</Ext13>
<Ext14>sample string 30</Ext14>
<Ext15>sample string 31</Ext15>
<Ext16>sample string 32</Ext16>
<Ext17>sample string 33</Ext17>
<Ext18>sample string 34</Ext18>
<Ext19>sample string 35</Ext19>
<Ext20>sample string 36</Ext20>
<Ext21>sample string 37</Ext21>
<Ext22>sample string 38</Ext22>
<Ext23>sample string 39</Ext23>
<Ext24>sample string 40</Ext24>
<Ext25>sample string 41</Ext25>
<Date1>2016-12-24T14:12:12</Date1>
<Date2>2016-12-24T14:12:12</Date2>
<Date3>2016-12-24T14:12:12</Date3>
<Date4>2016-12-24T14:12:12</Date4>
<Date5>2016-12-24T14:12:12</Date5>
<Num1>1</Num1>
<Num2>1</Num2>
<Num3>1</Num3>
<Num4>1</Num4>
<Num5>1</Num5>
<IsDeleted>true</IsDeleted>
<IsOptined>true</IsOptined>
<SubscribeIp>sample string 2</SubscribeIp>
<status>None</status>
<sms_status>None</sms_status>
<State>Unsubscribed</State>
</Contact>
<Pair>
<ApiPair>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</ApiPair>
<ApiPair>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</ApiPair>
</Pair>
</ApiContactPackage>
</ContactPackage>
</ApiMessageContact>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Name
Description
Type
Additional information
email_send
Amount of sent emails
integer
Response Formats
application/json, text/json
Sample:
{
"email_send": 1
}
application/xml, text/xml
Sample:
<ApiMessageInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <EmailSend>1</EmailSend> </ApiMessageInfo>