For more information on using API

POST http://webapi.mymarketing.co.il/api/external/operational/message

Create and send a new operational message

Request Information

URI Parameters

Body Parameters

ApiExternalOperationalMessage

Name

Description

Type

Additional information

package

ExternalId and ExternalName with collection of pairs of keys and values you provide to replace your placeholders in the operational message per recipient

Collection of ApiExternalPackage
details

See ApiMessageDetails

ApiMessageDetails

Required

design

See ApiMessageDesign

ApiMessageDesign

Required

bcc

See ApiMessageBCC

ApiMessageBCC

Request Formats

application/json, text/json

Sample: 
{
  "package": [
    {
      "pairs": [
        {
          "key": "sample string 1",
          "value": "sample string 2"
        },
        {
          "key": "sample string 1",
          "value": "sample string 2"
        }
      ],
      "externalId": "sample string 1",
      "externalName": "sample string 2"
    },
    {
      "pairs": [
        {
          "key": "sample string 1",
          "value": "sample string 2"
        },
        {
          "key": "sample string 1",
          "value": "sample string 2"
        }
      ],
      "externalId": "sample string 1",
      "externalName": "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: 
<ApiExternalOperationalMessage 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_fromname>sample string 4</user_profile_fromname>
    <user_profile_id>1</user_profile_id>
  </details>
  <package>
    <ApiExternalPackage>
      <externalId>sample string 1</externalId>
      <externalName>sample string 2</externalName>
      <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>
    </ApiExternalPackage>
    <ApiExternalPackage>
      <externalId>sample string 1</externalId>
      <externalName>sample string 2</externalName>
      <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>
    </ApiExternalPackage>
  </package>
</ApiExternalOperationalMessage>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiOperationalMessageFullInfo

Name

Description

Type

Additional information

campaign_id

Id of sent operational message

integer
message_id

Unique Id of sent operational message

integer
email_send

Amount of sent emails

integer

Response Formats

application/json, text/json

Sample: 
{
  "campaign_id": 1,
  "message_id": 1,
  "email_send": 2
}

application/xml, text/xml

Sample: 
<ApiOperationalMessageFullInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">
  <campaign_id>1</campaign_id>
  <email_send>2</email_send>
  <message_id>1</message_id>
</ApiOperationalMessageFullInfo>