POST api/SendInBlueEmail/SendSMTPMail

Request Information

URI Parameters

None.

Body Parameters

SendSmtpMail
NameDescriptionTypeAdditional information
tag

string

None.

CampaignName

string

None.

CampaignNameId

string

None.

sender

SendsmtpSender

None.

templateName

string

None.

TempelateID

integer

None.

htmlContent

string

None.

subject

string

None.

to

Collection of SendsmtpTo

None.

attachment

Collection of attachment

None.

Request Formats

application/json, text/json

Sample:
{
  "tag": "sample string 1",
  "CampaignName": "sample string 2",
  "CampaignNameId": "sample string 3",
  "sender": {
    "name": "sample string 1",
    "email": "sample string 2"
  },
  "templateName": "sample string 4",
  "TempelateID": 5,
  "htmlContent": "sample string 6",
  "subject": "sample string 7",
  "to": [
    {
      "name": "sample string 1",
      "email": "sample string 2"
    },
    {
      "name": "sample string 1",
      "email": "sample string 2"
    }
  ],
  "attachment": [
    {
      "content": "sample string 1",
      "name": "sample string 2"
    },
    {
      "content": "sample string 1",
      "name": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<SendSmtpMail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <CampaignName>sample string 2</CampaignName>
  <CampaignNameId>sample string 3</CampaignNameId>
  <TempelateID>5</TempelateID>
  <attachment>
    <attachment>
      <content>sample string 1</content>
      <name>sample string 2</name>
    </attachment>
    <attachment>
      <content>sample string 1</content>
      <name>sample string 2</name>
    </attachment>
  </attachment>
  <htmlContent>sample string 6</htmlContent>
  <sender>
    <email>sample string 2</email>
    <name>sample string 1</name>
  </sender>
  <subject>sample string 7</subject>
  <tag>sample string 1</tag>
  <templateName>sample string 4</templateName>
  <to>
    <SendsmtpTo>
      <email>sample string 2</email>
      <name>sample string 1</name>
    </SendsmtpTo>
    <SendsmtpTo>
      <email>sample string 2</email>
      <name>sample string 1</name>
    </SendsmtpTo>
  </to>
</SendSmtpMail>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VCAPIResponse
NameDescriptionTypeAdditional information
Version

string

None.

dateTime

string

None.

StatusCode

integer

None.

ErrorMessage

string

None.

Result

Object

None.

Response Formats

application/json, text/json

Sample:
{
  "Version": "1.0.0",
  "dateTime": "2020/07/31 21:33:08",
  "StatusCode": 1,
  "ErrorMessage": "sample string 2",
  "Result": {}
}

application/xml, text/xml

Sample:
<VCAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <ErrorMessage>sample string 2</ErrorMessage>
  <Result />
  <StatusCode>1</StatusCode>
</VCAPIResponse>