POST https://webapi.mymarketing.co.il/api/external/import
Import contacts
Request Information
URI Parameters
Body Parameters
Name
Description
Type
Additional information
mailing_list
Mailing list id
integer
group
Group id
integer
Request Formats
application/json, text/json
Sample:
{ "mailing_list": 1, "group": 1, "contacts": [ { "contact": { "email": "sample string 6", "sms": "sample string 7", "first_name": "sample string 8", "last_name": "sample string 9", "anniversary": "2016-12-24T14:12:12", "birthday": "2016-12-24T14:12:12", "city": "sample string 10", "fax": "sample string 11", "phone1": "sample string 12", "phone2": "sample string 13", "street": "sample string 14", "zip_code": "sample string 15", "ext1": "sample string 16", "ext2": "sample string 17", "ext3": "sample string 18", "ext4": "sample string 19", "ext5": "sample string 20", "ext6": "sample string 21", "ext7": "sample string 22", "ext8": "sample string 23", "ext9": "sample string 24", "ext10": "sample string 25", "ext11": "sample string 26", "ext12": "sample string 27", "ext13": "sample string 28", "ext14": "sample string 29", "ext15": "sample string 30", "ext16": "sample string 31", "ext17": "sample string 32", "ext18": "sample string 33", "ext19": "sample string 34", "ext20": "sample string 35", "ext21": "sample string 36", "ext22": "sample string 37", "ext23": "sample string 38", "ext24": "sample string 39", "ext25": "sample string 40", "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 }, "externalId": "sample string 1", "externalName": "sample string 2" }, { "contact": { "email": "sample string 6", "sms": "sample string 7", "first_name": "sample string 8", "last_name": "sample string 9", "anniversary": "2016-12-24T14:12:12", "birthday": "2016-12-24T14:12:12", "city": "sample string 10", "fax": "sample string 11", "phone1": "sample string 12", "phone2": "sample string 13", "street": "sample string 14", "zip_code": "sample string 15", "ext1": "sample string 16", "ext2": "sample string 17", "ext3": "sample string 18", "ext4": "sample string 19", "ext5": "sample string 20", "ext6": "sample string 21", "ext7": "sample string 22", "ext8": "sample string 23", "ext9": "sample string 24", "ext10": "sample string 25", "ext11": "sample string 26", "ext12": "sample string 27", "ext13": "sample string 28", "ext14": "sample string 29", "ext15": "sample string 30", "ext16": "sample string 31", "ext17": "sample string 32", "ext18": "sample string 33", "ext19": "sample string 34", "ext20": "sample string 35", "ext21": "sample string 36", "ext22": "sample string 37", "ext23": "sample string 38", "ext24": "sample string 39", "ext25": "sample string 40", "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 }, "externalId": "sample string 1", "externalName": "sample string 2" } ] }
application/xml, text/xml
Sample:
<ImportExternalContactsContainer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models"> <contacts> <ApiExternalContact> <externalId>sample string 1</externalId> <externalName>sample string 2</externalName> <contact> <anniversary>2016-12-24T14:12:12</anniversary> <birthday>2016-12-24T14:12:12</birthday> <city>sample string 10</city> <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> <email>sample string 6</email> <ext1>sample string 16</ext1> <ext10>sample string 25</ext10> <ext11>sample string 26</ext11> <ext12>sample string 27</ext12> <ext13>sample string 28</ext13> <ext14>sample string 29</ext14> <ext15>sample string 30</ext15> <ext16>sample string 31</ext16> <ext17>sample string 32</ext17> <ext18>sample string 33</ext18> <ext19>sample string 34</ext19> <ext2>sample string 17</ext2> <ext20>sample string 35</ext20> <ext21>sample string 36</ext21> <ext22>sample string 37</ext22> <ext23>sample string 38</ext23> <ext24>sample string 39</ext24> <ext25>sample string 40</ext25> <ext3>sample string 18</ext3> <ext4>sample string 19</ext4> <ext5>sample string 20</ext5> <ext6>sample string 21</ext6> <ext7>sample string 22</ext7> <ext8>sample string 23</ext8> <ext9>sample string 24</ext9> <fax>sample string 11</fax> <first_name>sample string 8</first_name> <is_deleted>true</is_deleted> <is_do_not_mail>true</is_do_not_mail> <last_name>sample string 9</last_name> <num1>1</num1> <num2>1</num2> <num3>1</num3> <num4>1</num4> <num5>1</num5> <phone1>sample string 12</phone1> <phone2>sample string 13</phone2> <sms>sample string 7</sms> <street>sample string 14</street> <zip_code>sample string 15</zip_code> </contact> </ApiExternalContact> <ApiExternalContact> <externalId>sample string 1</externalId> <externalName>sample string 2</externalName> <contact> <anniversary>2016-12-24T14:12:12</anniversary> <birthday>2016-12-24T14:12:12</birthday> <city>sample string 10</city> <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> <email>sample string 6</email> <ext1>sample string 16</ext1> <ext10>sample string 25</ext10> <ext11>sample string 26</ext11> <ext12>sample string 27</ext12> <ext13>sample string 28</ext13> <ext14>sample string 29</ext14> <ext15>sample string 30</ext15> <ext16>sample string 31</ext16> <ext17>sample string 32</ext17> <ext18>sample string 33</ext18> <ext19>sample string 34</ext19> <ext2>sample string 17</ext2> <ext20>sample string 35</ext20> <ext21>sample string 36</ext21> <ext22>sample string 37</ext22> <ext23>sample string 38</ext23> <ext24>sample string 39</ext24> <ext25>sample string 40</ext25> <ext3>sample string 18</ext3> <ext4>sample string 19</ext4> <ext5>sample string 20</ext5> <ext6>sample string 21</ext6> <ext7>sample string 22</ext7> <ext8>sample string 23</ext8> <ext9>sample string 24</ext9> <fax>sample string 11</fax> <first_name>sample string 8</first_name> <is_deleted>true</is_deleted> <is_do_not_mail>true</is_do_not_mail> <last_name>sample string 9</last_name> <num1>1</num1> <num2>1</num2> <num3>1</num3> <num4>1</num4> <num5>1</num5> <phone1>sample string 12</phone1> <phone2>sample string 13</phone2> <sms>sample string 7</sms> <street>sample string 14</street> <zip_code>sample string 15</zip_code> </contact> </ApiExternalContact> </contacts> <group>1</group> <mailing_list>1</mailing_list> </ImportExternalContactsContainer>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Name
Description
Type
Additional information
success_count
Number of success contacts
integer
Response Formats
application/json, text/json
Sample:
{ "success_count": 1, "contact_errors": [ { "message": "sample string 1", "contact_error": { "externalId": "sample string 1", "externalName": "sample string 2" } }, { "message": "sample string 1", "contact_error": { "externalId": "sample string 1", "externalName": "sample string 2" } } ], "success_customers": [ { "customerId": 1, "email": "sample string 2", "sms": "sample string 3", "externalId": "sample string 4", "externalName": "sample string 5" }, { "customerId": 1, "email": "sample string 2", "sms": "sample string 3", "externalId": "sample string 4", "externalName": "sample string 5" } ] }
application/xml, text/xml
Sample:
<FullExternalImportResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models"> <contact_errors> <ExternalContactError> <contact_error> <externalId>sample string 1</externalId> <externalName>sample string 2</externalName> </contact_error> <message>sample string 1</message> </ExternalContactError> <ExternalContactError> <contact_error> <externalId>sample string 1</externalId> <externalName>sample string 2</externalName> </contact_error> <message>sample string 1</message> </ExternalContactError> </contact_errors> <success_count>1</success_count> <success_customers> <ExternalImportSuccessCustomer> <externalId>sample string 4</externalId> <externalName>sample string 5</externalName> <customerId>1</customerId> <email>sample string 2</email> <sms>sample string 3</sms> </ExternalImportSuccessCustomer> <ExternalImportSuccessCustomer> <externalId>sample string 4</externalId> <externalName>sample string 5</externalName> <customerId>1</customerId> <email>sample string 2</email> <sms>sample string 3</sms> </ExternalImportSuccessCustomer> </success_customers> </FullExternalImportResult>