POST api/v1/campaigns

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	globally unique identifier	None.
Code	string	None.
Name	string	None.
StartDate	date	None.
EndDate	date	None.
CampaignTypeCode	string	None.
Communications	Collection of CampaignCommunicationDto	None.
MkActions	Collection of MkActionDto	None.

Request Formats

application/json, text/json

Sample:

{
  "id": "e52dd025-b21d-4bb4-897f-f199dbde7dc6",
  "code": "sample string 1",
  "name": "sample string 2",
  "startDate": "2026-02-04T06:15:46.4093842+00:00",
  "endDate": "2026-02-04T06:15:46.4093842+00:00",
  "campaignTypeCode": "sample string 3",
  "communications": [
    {
      "campaignId": "786855cb-7f74-441b-8e1a-5d30f84e99fa",
      "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": "2ffc8f4d-cb22-454d-8e93-7a5876a11745",
          "communicationType": 0,
          "sendDate": "2026-02-04T06:15:46.4093842+00:00"
        },
        {
          "id": "2ffc8f4d-cb22-454d-8e93-7a5876a11745",
          "communicationType": 0,
          "sendDate": "2026-02-04T06:15:46.4093842+00:00"
        }
      ],
      "id": "3155c330-4dbe-4490-a3d3-fe648dbabb7c",
      "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-04T06:15:46.4093842+00:00",
      "modificationDate": "2026-02-04T06:15:46.4093842+00:00",
      "isDraft": true,
      "isSent": true,
      "sendDate": "2026-02-04T06:15:46.4093842+00:00",
      "sendNow": true,
      "query": "sample string 17",
      "segmentCodes": [
        "sample string 1",
        "sample string 2"
      ],
      "channelCommunicationCode": "sample string 18",
      "templateCommunicationCode": "sample string 19",
      "organizationSenderId": "2fef9153-0754-4595-8732-31b1b8a0377a",
      "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
    },
    {
      "campaignId": "786855cb-7f74-441b-8e1a-5d30f84e99fa",
      "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": "2ffc8f4d-cb22-454d-8e93-7a5876a11745",
          "communicationType": 0,
          "sendDate": "2026-02-04T06:15:46.4093842+00:00"
        },
        {
          "id": "2ffc8f4d-cb22-454d-8e93-7a5876a11745",
          "communicationType": 0,
          "sendDate": "2026-02-04T06:15:46.4093842+00:00"
        }
      ],
      "id": "3155c330-4dbe-4490-a3d3-fe648dbabb7c",
      "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-04T06:15:46.4093842+00:00",
      "modificationDate": "2026-02-04T06:15:46.4093842+00:00",
      "isDraft": true,
      "isSent": true,
      "sendDate": "2026-02-04T06:15:46.4093842+00:00",
      "sendNow": true,
      "query": "sample string 17",
      "segmentCodes": [
        "sample string 1",
        "sample string 2"
      ],
      "channelCommunicationCode": "sample string 18",
      "templateCommunicationCode": "sample string 19",
      "organizationSenderId": "2fef9153-0754-4595-8732-31b1b8a0377a",
      "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
    }
  ],
  "mkActions": [
    {
      "id": "b3d7de18-4eab-43a4-9e74-0c9cc7cd3448",
      "code": "sample string 1",
      "title": "sample string 2",
      "description": "sample string 3",
      "beginDate": "2026-02-04T06:15:46.4093842+00:00",
      "endDate": "2026-02-04T06:15:46.4093842+00:00",
      "isDraft": true,
      "urlImage": "sample string 5",
      "imageBase64": "sample string 6",
      "mkActionCategoryCode": "sample string 7",
      "mkActionCategoryName": "sample string 8",
      "campaignCode": "sample string 9",
      "creationDate": "2026-02-04T06:15:46.4093842+00:00"
    },
    {
      "id": "b3d7de18-4eab-43a4-9e74-0c9cc7cd3448",
      "code": "sample string 1",
      "title": "sample string 2",
      "description": "sample string 3",
      "beginDate": "2026-02-04T06:15:46.4093842+00:00",
      "endDate": "2026-02-04T06:15:46.4093842+00:00",
      "isDraft": true,
      "urlImage": "sample string 5",
      "imageBase64": "sample string 6",
      "mkActionCategoryCode": "sample string 7",
      "mkActionCategoryName": "sample string 8",
      "campaignCode": "sample string 9",
      "creationDate": "2026-02-04T06:15:46.4093842+00:00"
    }
  ]
}

application/xml, text/xml

Sample:

<CampaignDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Domain.Dtos">
  <CampaignTypeCode>sample string 3</CampaignTypeCode>
  <Code>sample string 1</Code>
  <Communications>
    <CampaignCommunicationDto>
      <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-04T06:15:46.4093842+00:00</CreationDate>
      <Delivered>28</Delivered>
      <Forwarded>29</Forwarded>
      <Id>3155c330-4dbe-4490-a3d3-fe648dbabb7c</Id>
      <Impressions>23</Impressions>
      <IsDraft>true</IsDraft>
      <IsFromSystem>true</IsFromSystem>
      <IsSent>true</IsSent>
      <MkActionCode>sample string 20</MkActionCode>
      <ModificationDate>2026-02-04T06:15:46.4093842+00:00</ModificationDate>
      <Name>sample string 10</Name>
      <OrganizationCode>sample string 9</OrganizationCode>
      <OrganizationSenderId>2fef9153-0754-4595-8732-31b1b8a0377a</OrganizationSenderId>
      <PromotionCode>sample string 21</PromotionCode>
      <Query>sample string 17</Query>
      <ReportSpam>27</ReportSpam>
      <SegmentCodes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </SegmentCodes>
      <SendDate>2026-02-04T06:15:46.4093842+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>786855cb-7f74-441b-8e1a-5d30f84e99fa</CampaignId>
      <CampaignTypeCode>sample string 3</CampaignTypeCode>
      <CampaignTypeName>sample string 4</CampaignTypeName>
      <ChildCommunications>
        <ChildCommunicationDto>
          <CommunicationType>Regular</CommunicationType>
          <Id>2ffc8f4d-cb22-454d-8e93-7a5876a11745</Id>
          <SendDate>2026-02-04T06:15:46.4093842+00:00</SendDate>
        </ChildCommunicationDto>
        <ChildCommunicationDto>
          <CommunicationType>Regular</CommunicationType>
          <Id>2ffc8f4d-cb22-454d-8e93-7a5876a11745</Id>
          <SendDate>2026-02-04T06:15:46.4093842+00:00</SendDate>
        </ChildCommunicationDto>
      </ChildCommunications>
      <CommunicationType>Regular</CommunicationType>
      <ProductCategoryCode>sample string 7</ProductCategoryCode>
      <ProductCode>sample string 5</ProductCode>
    </CampaignCommunicationDto>
    <CampaignCommunicationDto>
      <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-04T06:15:46.4093842+00:00</CreationDate>
      <Delivered>28</Delivered>
      <Forwarded>29</Forwarded>
      <Id>3155c330-4dbe-4490-a3d3-fe648dbabb7c</Id>
      <Impressions>23</Impressions>
      <IsDraft>true</IsDraft>
      <IsFromSystem>true</IsFromSystem>
      <IsSent>true</IsSent>
      <MkActionCode>sample string 20</MkActionCode>
      <ModificationDate>2026-02-04T06:15:46.4093842+00:00</ModificationDate>
      <Name>sample string 10</Name>
      <OrganizationCode>sample string 9</OrganizationCode>
      <OrganizationSenderId>2fef9153-0754-4595-8732-31b1b8a0377a</OrganizationSenderId>
      <PromotionCode>sample string 21</PromotionCode>
      <Query>sample string 17</Query>
      <ReportSpam>27</ReportSpam>
      <SegmentCodes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </SegmentCodes>
      <SendDate>2026-02-04T06:15:46.4093842+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>786855cb-7f74-441b-8e1a-5d30f84e99fa</CampaignId>
      <CampaignTypeCode>sample string 3</CampaignTypeCode>
      <CampaignTypeName>sample string 4</CampaignTypeName>
      <ChildCommunications>
        <ChildCommunicationDto>
          <CommunicationType>Regular</CommunicationType>
          <Id>2ffc8f4d-cb22-454d-8e93-7a5876a11745</Id>
          <SendDate>2026-02-04T06:15:46.4093842+00:00</SendDate>
        </ChildCommunicationDto>
        <ChildCommunicationDto>
          <CommunicationType>Regular</CommunicationType>
          <Id>2ffc8f4d-cb22-454d-8e93-7a5876a11745</Id>
          <SendDate>2026-02-04T06:15:46.4093842+00:00</SendDate>
        </ChildCommunicationDto>
      </ChildCommunications>
      <CommunicationType>Regular</CommunicationType>
      <ProductCategoryCode>sample string 7</ProductCategoryCode>
      <ProductCode>sample string 5</ProductCode>
    </CampaignCommunicationDto>
  </Communications>
  <EndDate>2026-02-04T06:15:46.4093842+00:00</EndDate>
  <Id>e52dd025-b21d-4bb4-897f-f199dbde7dc6</Id>
  <MkActions>
    <MkActionDto>
      <BeginDate>2026-02-04T06:15:46.4093842+00:00</BeginDate>
      <CampaignCode>sample string 9</CampaignCode>
      <Code>sample string 1</Code>
      <CreationDate>2026-02-04T06:15:46.4093842+00:00</CreationDate>
      <Description>sample string 3</Description>
      <EndDate>2026-02-04T06:15:46.4093842+00:00</EndDate>
      <Id>b3d7de18-4eab-43a4-9e74-0c9cc7cd3448</Id>
      <ImageBase64>sample string 6</ImageBase64>
      <IsDraft>true</IsDraft>
      <MkActionCategoryCode>sample string 7</MkActionCategoryCode>
      <MkActionCategoryName>sample string 8</MkActionCategoryName>
      <Title>sample string 2</Title>
      <UrlImage>sample string 5</UrlImage>
    </MkActionDto>
    <MkActionDto>
      <BeginDate>2026-02-04T06:15:46.4093842+00:00</BeginDate>
      <CampaignCode>sample string 9</CampaignCode>
      <Code>sample string 1</Code>
      <CreationDate>2026-02-04T06:15:46.4093842+00:00</CreationDate>
      <Description>sample string 3</Description>
      <EndDate>2026-02-04T06:15:46.4093842+00:00</EndDate>
      <Id>b3d7de18-4eab-43a4-9e74-0c9cc7cd3448</Id>
      <ImageBase64>sample string 6</ImageBase64>
      <IsDraft>true</IsDraft>
      <MkActionCategoryCode>sample string 7</MkActionCategoryCode>
      <MkActionCategoryName>sample string 8</MkActionCategoryName>
      <Title>sample string 2</Title>
      <UrlImage>sample string 5</UrlImage>
    </MkActionDto>
  </MkActions>
  <Name>sample string 2</Name>
  <StartDate>2026-02-04T06:15:46.4093842+00:00</StartDate>
</CampaignDto>

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.