GET api/v1/campaigncommunications/{code}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
code

string

Required

Body Parameters

None.

Response Information

Resource Description

SingleResultResponseOfCampaignCommunicationDto
NameDescriptionTypeAdditional information
Meta

MetaSingleResult

None.

Notifications

None.

Response Formats

application/json, text/json

Sample:
{
  "meta": {},
  "notifications": [
    {},
    {}
  ],
  "result": {
    "campaignId": "15d9ebfe-a75d-42f7-98b9-0b51e7d3ab7e",
    "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": "f64dd817-33ac-4816-9548-76a56dea2c49",
        "communicationType": 0,
        "sendDate": "2026-03-23T09:09:39.8248669+00:00"
      },
      {
        "id": "f64dd817-33ac-4816-9548-76a56dea2c49",
        "communicationType": 0,
        "sendDate": "2026-03-23T09:09:39.8248669+00:00"
      }
    ],
    "id": "00bd26c0-0f11-45fb-9efc-0a02abb07ffb",
    "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-03-23T09:09:39.8248669+00:00",
    "modificationDate": "2026-03-23T09:09:39.8248669+00:00",
    "isDraft": true,
    "isSent": true,
    "sendDate": "2026-03-23T09:09:39.8248669+00:00",
    "sendNow": true,
    "query": "sample string 17",
    "segmentCodes": [
      "sample string 1",
      "sample string 2"
    ],
    "channelCommunicationCode": "sample string 18",
    "templateCommunicationCode": "sample string 19",
    "organizationSenderId": "a037ec47-304d-4abb-b1ac-73de9132e971",
    "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:
<SingleResultResponseOfCampaignCommunicationDtoaM_S85dVU xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Presentation.WebApi.Dtos.Response">
  <Meta />
  <Notifications>
    <Notification />
    <Notification />
  </Notifications>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/Domain.Dtos">
    <d2p1:Body>sample string 12</d2p1:Body>
    <d2p1:BodyTemplate>sample string 13</d2p1:BodyTemplate>
    <d2p1:Bounced>26</d2p1:Bounced>
    <d2p1:ChannelCommunicationCode>sample string 18</d2p1:ChannelCommunicationCode>
    <d2p1:Clicks>24</d2p1:Clicks>
    <d2p1:Code>sample string 8</d2p1:Code>
    <d2p1:CreationDate>2026-03-23T09:09:39.8248669+00:00</d2p1:CreationDate>
    <d2p1:Delivered>28</d2p1:Delivered>
    <d2p1:Forwarded>29</d2p1:Forwarded>
    <d2p1:Id>00bd26c0-0f11-45fb-9efc-0a02abb07ffb</d2p1:Id>
    <d2p1:Impressions>23</d2p1:Impressions>
    <d2p1:IsDraft>true</d2p1:IsDraft>
    <d2p1:IsFromSystem>true</d2p1:IsFromSystem>
    <d2p1:IsSent>true</d2p1:IsSent>
    <d2p1:MkActionCode>sample string 20</d2p1:MkActionCode>
    <d2p1:ModificationDate>2026-03-23T09:09:39.8248669+00:00</d2p1:ModificationDate>
    <d2p1:Name>sample string 10</d2p1:Name>
    <d2p1:OrganizationCode>sample string 9</d2p1:OrganizationCode>
    <d2p1:OrganizationSenderId>a037ec47-304d-4abb-b1ac-73de9132e971</d2p1:OrganizationSenderId>
    <d2p1:PromotionCode>sample string 21</d2p1:PromotionCode>
    <d2p1:Query>sample string 17</d2p1:Query>
    <d2p1:ReportSpam>27</d2p1:ReportSpam>
    <d2p1:SegmentCodes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:SegmentCodes>
    <d2p1:SendDate>2026-03-23T09:09:39.8248669+00:00</d2p1:SendDate>
    <d2p1:SendNow>true</d2p1:SendNow>
    <d2p1:Sent>25</d2p1:Sent>
    <d2p1:Subject>sample string 11</d2p1:Subject>
    <d2p1:TemplateCommunicationCode>sample string 19</d2p1:TemplateCommunicationCode>
    <d2p1:UnSub>30</d2p1:UnSub>
    <d2p1:BrandCode>sample string 6</d2p1:BrandCode>
    <d2p1:CampaignCode>sample string 2</d2p1:CampaignCode>
    <d2p1:CampaignId>15d9ebfe-a75d-42f7-98b9-0b51e7d3ab7e</d2p1:CampaignId>
    <d2p1:CampaignTypeCode>sample string 3</d2p1:CampaignTypeCode>
    <d2p1:CampaignTypeName>sample string 4</d2p1:CampaignTypeName>
    <d2p1:ChildCommunications>
      <d2p1:ChildCommunicationDto>
        <d2p1:CommunicationType>Regular</d2p1:CommunicationType>
        <d2p1:Id>f64dd817-33ac-4816-9548-76a56dea2c49</d2p1:Id>
        <d2p1:SendDate>2026-03-23T09:09:39.8248669+00:00</d2p1:SendDate>
      </d2p1:ChildCommunicationDto>
      <d2p1:ChildCommunicationDto>
        <d2p1:CommunicationType>Regular</d2p1:CommunicationType>
        <d2p1:Id>f64dd817-33ac-4816-9548-76a56dea2c49</d2p1:Id>
        <d2p1:SendDate>2026-03-23T09:09:39.8248669+00:00</d2p1:SendDate>
      </d2p1:ChildCommunicationDto>
    </d2p1:ChildCommunications>
    <d2p1:CommunicationType>Regular</d2p1:CommunicationType>
    <d2p1:ProductCategoryCode>sample string 7</d2p1:ProductCategoryCode>
    <d2p1:ProductCode>sample string 5</d2p1:ProductCode>
  </Result>
</SingleResultResponseOfCampaignCommunicationDtoaM_S85dVU>