POST api/v1/campaigncommunications

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CampaignId	globally unique identifier	None.
CampaignCode	string	None.
CampaignTypeCode	string	None.
CampaignTypeName	string	None.
ProductCode	string	None.
BrandCode	string	None.
ProductCategoryCode	string	None.
CommunicationType	CommunicationType	None.
ChildCommunications	Collection of ChildCommunicationDto	None.
Id	globally unique identifier	None.
Code	string	None.
OrganizationCode	string	None.
Name	string	None.
Subject	string	None.
Body	string	None.
BodyTemplate	string	None.
CreationDate	date	None.
ModificationDate	date	None.
IsDraft	boolean	None.
IsSent	boolean	None.
SendDate	date	None.
SendNow	boolean	None.
Query	string	None.
SegmentCodes	Collection of string	None.
ChannelCommunicationCode	string	None.
TemplateCommunicationCode	string	None.
OrganizationSenderId	globally unique identifier	None.
MkActionCode	string	None.
PromotionCode	string	None.
IsFromSystem	boolean	None.
Impressions	integer	None.
Clicks	integer	None.
Sent	integer	None.
Bounced	integer	None.
ReportSpam	integer	None.
Delivered	integer	None.
Forwarded	integer	None.
UnSub	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "campaignId": "623e9bc2-ea27-4916-8b90-b6f95c6f73d6",
  "campaignCode": "sample string 2",
  "campaignTypeCode": "sample string 3",
  "campaignTypeName": "sample string 4",
  "productCode": "sample string 5",
  "brandCode": "sample string 6",
  "productCategoryCode": "sample string 7",
  "communicationType": 0,
  "childCommunications": [
    {
      "id": "6ee32ff8-36db-4ba5-a2d7-2307c5e3b135",
      "communicationType": 0,
      "sendDate": "2026-02-04T03:05:47.959298+00:00"
    },
    {
      "id": "6ee32ff8-36db-4ba5-a2d7-2307c5e3b135",
      "communicationType": 0,
      "sendDate": "2026-02-04T03:05:47.959298+00:00"
    }
  ],
  "id": "bcfb20a7-049c-4a8d-8f85-f8fd9f95fe24",
  "code": "sample string 8",
  "organizationCode": "sample string 9",
  "name": "sample string 10",
  "subject": "sample string 11",
  "body": "sample string 12",
  "bodyTemplate": "sample string 13",
  "creationDate": "2026-02-04T03:05:47.959298+00:00",
  "modificationDate": "2026-02-04T03:05:47.959298+00:00",
  "isDraft": true,
  "isSent": true,
  "sendDate": "2026-02-04T03:05:47.959298+00:00",
  "sendNow": true,
  "query": "sample string 17",
  "segmentCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "channelCommunicationCode": "sample string 18",
  "templateCommunicationCode": "sample string 19",
  "organizationSenderId": "f64b3855-c404-4708-875c-55143d2d87be",
  "mkActionCode": "sample string 20",
  "promotionCode": "sample string 21",
  "isFromSystem": true,
  "impressions": 23,
  "clicks": 24,
  "sent": 25,
  "bounced": 26,
  "reportSpam": 27,
  "delivered": 28,
  "forwarded": 29,
  "unSub": 30
}

application/xml, text/xml

Sample:

<CampaignCommunicationDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Domain.Dtos">
  <Body>sample string 12</Body>
  <BodyTemplate>sample string 13</BodyTemplate>
  <Bounced>26</Bounced>
  <ChannelCommunicationCode>sample string 18</ChannelCommunicationCode>
  <Clicks>24</Clicks>
  <Code>sample string 8</Code>
  <CreationDate>2026-02-04T03:05:47.959298+00:00</CreationDate>
  <Delivered>28</Delivered>
  <Forwarded>29</Forwarded>
  <Id>bcfb20a7-049c-4a8d-8f85-f8fd9f95fe24</Id>
  <Impressions>23</Impressions>
  <IsDraft>true</IsDraft>
  <IsFromSystem>true</IsFromSystem>
  <IsSent>true</IsSent>
  <MkActionCode>sample string 20</MkActionCode>
  <ModificationDate>2026-02-04T03:05:47.959298+00:00</ModificationDate>
  <Name>sample string 10</Name>
  <OrganizationCode>sample string 9</OrganizationCode>
  <OrganizationSenderId>f64b3855-c404-4708-875c-55143d2d87be</OrganizationSenderId>
  <PromotionCode>sample string 21</PromotionCode>
  <Query>sample string 17</Query>
  <ReportSpam>27</ReportSpam>
  <SegmentCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </SegmentCodes>
  <SendDate>2026-02-04T03:05:47.959298+00:00</SendDate>
  <SendNow>true</SendNow>
  <Sent>25</Sent>
  <Subject>sample string 11</Subject>
  <TemplateCommunicationCode>sample string 19</TemplateCommunicationCode>
  <UnSub>30</UnSub>
  <BrandCode>sample string 6</BrandCode>
  <CampaignCode>sample string 2</CampaignCode>
  <CampaignId>623e9bc2-ea27-4916-8b90-b6f95c6f73d6</CampaignId>
  <CampaignTypeCode>sample string 3</CampaignTypeCode>
  <CampaignTypeName>sample string 4</CampaignTypeName>
  <ChildCommunications>
    <ChildCommunicationDto>
      <CommunicationType>Regular</CommunicationType>
      <Id>6ee32ff8-36db-4ba5-a2d7-2307c5e3b135</Id>
      <SendDate>2026-02-04T03:05:47.959298+00:00</SendDate>
    </ChildCommunicationDto>
    <ChildCommunicationDto>
      <CommunicationType>Regular</CommunicationType>
      <Id>6ee32ff8-36db-4ba5-a2d7-2307c5e3b135</Id>
      <SendDate>2026-02-04T03:05:47.959298+00:00</SendDate>
    </ChildCommunicationDto>
  </ChildCommunications>
  <CommunicationType>Regular</CommunicationType>
  <ProductCategoryCode>sample string 7</ProductCategoryCode>
  <ProductCode>sample string 5</ProductCode>
</CampaignCommunicationDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.