For more information on using API

POST http://webapi.mymarketing.co.il/api/OperationalMessage/Contacts

Create and send a new message to Contacts

Request Information

URI Parameters

Body Parameters

ApiMessageContact

Name

Description

Type

Additional information

ContactPackage

Contact with collection of pairs of keys and values you provide to replace your placeholders in the operational email per recipient

Collection of ApiContactPackage
Details

See ApiMessageDetails

Required

Design

See ApiMessageDesign

Required

BCC

See ApiMessageBCC

Request Formats

application/json, text/json

Sample:
{
  "contact_package": [
    {
      "contact": {
        "email": "sample string 2",
        "sms": "sample string 3",
        "first_name": "sample string 4",
        "last_name": "sample string 5",
        "anniversary": "2016-12-24T14:12:12",
        "birthday": "2016-12-24T14:12:12",
        "city": "sample string 6",
        "fax": "sample string 7",
        "phone1": "sample string 8",
        "phone2": "sample string 9",
        "street": "sample string 10",
        "zip_code": "sample string 11",
        "ext1": "sample string 12",
        "ext2": "sample string 13",
        "ext3": "sample string 14",
        "ext4": "sample string 15",
        "ext5": "sample string 16",
        "ext6": "sample string 17",
        "ext7": "sample string 18",
        "ext8": "sample string 19",
        "ext9": "sample string 20",
        "ext10": "sample string 21",
        "ext11": "sample string 22",
        "ext12": "sample string 23",
        "ext13": "sample string 24",
        "ext14": "sample string 25",
        "ext15": "sample string 26",
        "ext16": "sample string 27",
        "ext17": "sample string 28",
        "ext18": "sample string 29",
        "ext19": "sample string 30",
        "ext20": "sample string 31",
        "ext21": "sample string 32",
        "ext22": "sample string 33",
        "ext23": "sample string 34",
        "ext24": "sample string 35",
        "ext25": "sample string 36",
        "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_do_not_mail": true,
        "is_deleted": true
      },
      "pairs": [
        {
          "key": "sample string 1",
          "value": "sample string 2"
        },
        {
          "key": "sample string 1",
          "value": "sample string 2"
        }
      ]
    },
    {
      "contact": {
        "email": "sample string 2",
        "sms": "sample string 3",
        "first_name": "sample string 4",
        "last_name": "sample string 5",
        "anniversary": "2016-12-24T14:12:12",
        "birthday": "2016-12-24T14:12:12",
        "city": "sample string 6",
        "fax": "sample string 7",
        "phone1": "sample string 8",
        "phone2": "sample string 9",
        "street": "sample string 10",
        "zip_code": "sample string 11",
        "ext1": "sample string 12",
        "ext2": "sample string 13",
        "ext3": "sample string 14",
        "ext4": "sample string 15",
        "ext5": "sample string 16",
        "ext6": "sample string 17",
        "ext7": "sample string 18",
        "ext8": "sample string 19",
        "ext9": "sample string 20",
        "ext10": "sample string 21",
        "ext11": "sample string 22",
        "ext12": "sample string 23",
        "ext13": "sample string 24",
        "ext14": "sample string 25",
        "ext15": "sample string 26",
        "ext16": "sample string 27",
        "ext17": "sample string 28",
        "ext18": "sample string 29",
        "ext19": "sample string 30",
        "ext20": "sample string 31",
        "ext21": "sample string 32",
        "ext22": "sample string 33",
        "ext23": "sample string 34",
        "ext24": "sample string 35",
        "ext25": "sample string 36",
        "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_do_not_mail": true,
        "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"
  },
  "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:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">
  <bcc>
    <bcc_emails xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </bcc_emails>
  </bcc>
  <design>
    <add_Statistics>true</add_Statistics>
    <add_print_button>true</add_print_button>
    <body_part_format>HTML</body_part_format>
    <content>sample string 1</content>
    <language_type>IBM_EBCDIC_US_Canada</language_type>
    <template_id>3</template_id>
  </design>
  <details>
    <classification>sample string 3</classification>
    <name>sample string 1</name>
    <reply_to_email i:nil="true" />
    <subject>sample string 2</subject>
    <user_profile_id>1</user_profile_id>
  </details>
  <ContactPackage>
    <ApiContactPackage>
      <contact>
        <anniversary>2016-12-24T14:12:12</anniversary>
        <birthday>2016-12-24T14:12:12</birthday>
        <city>sample string 6</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 2</email>
        <ext1>sample string 12</ext1>
        <ext10>sample string 21</ext10>
        <ext11>sample string 22</ext11>
        <ext12>sample string 23</ext12>
        <ext13>sample string 24</ext13>
        <ext14>sample string 25</ext14>
        <ext15>sample string 26</ext15>
        <ext16>sample string 27</ext16>
        <ext17>sample string 28</ext17>
        <ext18>sample string 29</ext18>
        <ext19>sample string 30</ext19>
        <ext2>sample string 13</ext2>
        <ext20>sample string 31</ext20>
        <ext21>sample string 32</ext21>
        <ext22>sample string 33</ext22>
        <ext23>sample string 34</ext23>
        <ext24>sample string 35</ext24>
        <ext25>sample string 36</ext25>
        <ext3>sample string 14</ext3>
        <ext4>sample string 15</ext4>
        <ext5>sample string 16</ext5>
        <ext6>sample string 17</ext6>
        <ext7>sample string 18</ext7>
        <ext8>sample string 19</ext8>
        <ext9>sample string 20</ext9>
        <fax>sample string 7</fax>
        <first_name>sample string 4</first_name>
        <is_deleted>true</is_deleted>
        <is_do_not_mail>true</is_do_not_mail>
        <last_name>sample string 5</last_name>
        <num1>1</num1>
        <num2>1</num2>
        <num3>1</num3>
        <num4>1</num4>
        <num5>1</num5>
        <phone1>sample string 8</phone1>
        <phone2>sample string 9</phone2>
        <sms>sample string 3</sms>
        <street>sample string 10</street>
        <zip_code>sample string 11</zip_code>
      </contact>
      <pairs>
        <ApiPair>
          <key>sample string 1</key>
          <value>sample string 2</value>
        </ApiPair>
        <ApiPair>
          <key>sample string 1</key>
          <value>sample string 2</value>
        </ApiPair>
      </pairs>
    </ApiContactPackage>
    <ApiContactPackage>
      <contact>
        <anniversary>2016-12-24T14:12:12</anniversary>
        <birthday>2016-12-24T14:12:12</birthday>
        <city>sample string 6</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 2</email>
        <ext1>sample string 12</ext1>
        <ext10>sample string 21</ext10>
        <ext11>sample string 22</ext11>
        <ext12>sample string 23</ext12>
        <ext13>sample string 24</ext13>
        <ext14>sample string 25</ext14>
        <ext15>sample string 26</ext15>
        <ext16>sample string 27</ext16>
        <ext17>sample string 28</ext17>
        <ext18>sample string 29</ext18>
        <ext19>sample string 30</ext19>
        <ext2>sample string 13</ext2>
        <ext20>sample string 31</ext20>
        <ext21>sample string 32</ext21>
        <ext22>sample string 33</ext22>
        <ext23>sample string 34</ext23>
        <ext24>sample string 35</ext24>
        <ext25>sample string 36</ext25>
        <ext3>sample string 14</ext3>
        <ext4>sample string 15</ext4>
        <ext5>sample string 16</ext5>
        <ext6>sample string 17</ext6>
        <ext7>sample string 18</ext7>
        <ext8>sample string 19</ext8>
        <ext9>sample string 20</ext9>
        <fax>sample string 7</fax>
        <first_name>sample string 4</first_name>
        <is_deleted>true</is_deleted>
        <is_do_not_mail>true</is_do_not_mail>
        <last_name>sample string 5</last_name>
        <num1>1</num1>
        <num2>1</num2>
        <num3>1</num3>
        <num4>1</num4>
        <num5>1</num5>
        <phone1>sample string 8</phone1>
        <phone2>sample string 9</phone2>
        <sms>sample string 3</sms>
        <street>sample string 10</street>
        <zip_code>sample string 11</zip_code>
      </contact>
      <pairs>
        <ApiPair>
          <key>sample string 1</key>
          <value>sample string 2</value>
        </ApiPair>
        <ApiPair>
          <key>sample string 1</key>
          <value>sample string 2</value>
        </ApiPair>
      </pairs>
    </ApiContactPackage>
  </ContactPackage>
</ApiMessageContact>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiMessageInfo

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:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">
  <email_send>1</email_send>
</ApiMessageInfo>