POST api/Transmission

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	string	None.
State	string	None.
Options	Options	None.
Recipients	Collection of Recipient	None.
ListId	string	None.
CampaignId	string	None.
Description	string	None.
Metadata	Dictionary of string [key] and Object [value]	None.
SubstitutionData	Dictionary of string [key] and Object [value]	None.
ReturnPath	string	None.
Content	Content	None.
TotalRecipients	integer	None.
NumGenerated	integer	None.
NumFailedGeneration	integer	None.
NumInvalidRecipients	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "sample string 1",
  "State": "sample string 2",
  "Options": {
    "StartTime": "2025-04-04T01:00:11.5592768-04:00",
    "OpenTracking": true,
    "ClickTracking": true,
    "Transactional": true,
    "Sandbox": true,
    "SkipSuppression": true,
    "InlineCss": true,
    "IpPool": "sample string 1",
    "Vmta": "sample string 2"
  },
  "Recipients": [
    {
      "Address": {
        "Name": "sample string 1",
        "Email": "sample string 2",
        "HeaderTo": "sample string 3"
      },
      "ReturnPath": "sample string 1",
      "Tags": [
        "sample string 1",
        "sample string 2"
      ],
      "Metadata": {
        "sample string 1": {},
        "sample string 3": {}
      },
      "SubstitutionData": {
        "sample string 1": {},
        "sample string 3": {}
      },
      "Type": 0
    },
    {
      "Address": {
        "Name": "sample string 1",
        "Email": "sample string 2",
        "HeaderTo": "sample string 3"
      },
      "ReturnPath": "sample string 1",
      "Tags": [
        "sample string 1",
        "sample string 2"
      ],
      "Metadata": {
        "sample string 1": {},
        "sample string 3": {}
      },
      "SubstitutionData": {
        "sample string 1": {},
        "sample string 3": {}
      },
      "Type": 0
    }
  ],
  "ListId": "sample string 3",
  "CampaignId": "sample string 4",
  "Description": "sample string 5",
  "Metadata": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "SubstitutionData": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "ReturnPath": "sample string 6",
  "Content": {
    "Html": "sample string 1",
    "Text": "sample string 2",
    "Subject": "sample string 3",
    "From": {
      "Name": "sample string 1",
      "Email": "sample string 2",
      "HeaderTo": "sample string 3"
    },
    "ReplyTo": "sample string 4",
    "Headers": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "Attachments": [
      {
        "Type": "sample string 1",
        "Name": "sample string 2",
        "Data": "sample string 3"
      },
      {
        "Type": "sample string 1",
        "Name": "sample string 2",
        "Data": "sample string 3"
      }
    ],
    "InlineImages": [
      {
        "Type": "sample string 1",
        "Name": "sample string 2",
        "Data": "sample string 3"
      },
      {
        "Type": "sample string 1",
        "Name": "sample string 2",
        "Data": "sample string 3"
      }
    ],
    "TemplateId": "sample string 5",
    "UseDraftTemplate": true
  },
  "TotalRecipients": 7,
  "NumGenerated": 8,
  "NumFailedGeneration": 9,
  "NumInvalidRecipients": 10
}

application/xml, text/xml

Sample:

<Transmission xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VultusPowerSend">
  <CampaignId>sample string 4</CampaignId>
  <Content>
    <Attachments>
      <Attachment>
        <Data>sample string 3</Data>
        <Name>sample string 2</Name>
        <Type>sample string 1</Type>
      </Attachment>
      <Attachment>
        <Data>sample string 3</Data>
        <Name>sample string 2</Name>
        <Type>sample string 1</Type>
      </Attachment>
    </Attachments>
    <From>
      <Email>sample string 2</Email>
      <HeaderTo>sample string 3</HeaderTo>
      <Name>sample string 1</Name>
    </From>
    <Headers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Headers>
    <Html>sample string 1</Html>
    <InlineImages>
      <InlineImage>
        <Data>sample string 3</Data>
        <Name>sample string 2</Name>
        <Type>sample string 1</Type>
      </InlineImage>
      <InlineImage>
        <Data>sample string 3</Data>
        <Name>sample string 2</Name>
        <Type>sample string 1</Type>
      </InlineImage>
    </InlineImages>
    <ReplyTo>sample string 4</ReplyTo>
    <Subject>sample string 3</Subject>
    <TemplateId>sample string 5</TemplateId>
    <Text>sample string 2</Text>
    <UseDraftTemplate>true</UseDraftTemplate>
  </Content>
  <Description>sample string 5</Description>
  <Id>sample string 1</Id>
  <ListId>sample string 3</ListId>
  <Metadata xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </Metadata>
  <NumFailedGeneration>9</NumFailedGeneration>
  <NumGenerated>8</NumGenerated>
  <NumInvalidRecipients>10</NumInvalidRecipients>
  <Options>
    <ClickTracking>true</ClickTracking>
    <InlineCss>true</InlineCss>
    <IpPool>sample string 1</IpPool>
    <OpenTracking>true</OpenTracking>
    <Sandbox>true</Sandbox>
    <SkipSuppression>true</SkipSuppression>
    <StartTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-04-04T05:00:11.5592768Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </StartTime>
    <Transactional>true</Transactional>
    <Vmta>sample string 2</Vmta>
  </Options>
  <Recipients>
    <Recipient>
      <Address>
        <Email>sample string 2</Email>
        <HeaderTo>sample string 3</HeaderTo>
        <Name>sample string 1</Name>
      </Address>
      <Metadata xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </Metadata>
      <ReturnPath>sample string 1</ReturnPath>
      <SubstitutionData xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </SubstitutionData>
      <Tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Tags>
      <Type>To</Type>
    </Recipient>
    <Recipient>
      <Address>
        <Email>sample string 2</Email>
        <HeaderTo>sample string 3</HeaderTo>
        <Name>sample string 1</Name>
      </Address>
      <Metadata xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </Metadata>
      <ReturnPath>sample string 1</ReturnPath>
      <SubstitutionData xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </SubstitutionData>
      <Tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Tags>
      <Type>To</Type>
    </Recipient>
  </Recipients>
  <ReturnPath>sample string 6</ReturnPath>
  <State>sample string 2</State>
  <SubstitutionData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </SubstitutionData>
  <TotalRecipients>7</TotalRecipients>
</Transmission>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.