POST api/campaigns

Creates a campaign entity.

Request Information

URI Parameters

None.

Body Parameters

The campaign model to create with.

Name	Type	Additional information
OrderId	globally unique identifier	None.
DataListId	globally unique identifier	None.
DataFileIds	Collection of globally unique identifier	None.
RecordCount	integer	None.
IsPlaced	boolean	None.
ProductionComplete	boolean	None.
Id	globally unique identifier	None.
CreationDateUtc	date	None.
UserId	globally unique identifier	None.
TenantId	globally unique identifier	None.
SubtotalExVat	decimal number	None.
SubtotalIncVat	decimal number	None.
DiscountedTotalExVat	decimal number	None.
DiscountedTotalIncVat	decimal number	None.
VatRateApplied	decimal number	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderId": "d2592bd1-226a-4f9d-92dd-7b6d0c5779be",
  "DataListId": "2a965d46-63c4-4786-ab3e-7e65a2996f60",
  "DataFileIds": [
    "22f95f98-3380-41da-bb15-6f38fe44e91d",
    "54eb5172-81f9-4ac1-bcbd-f8e9d982f780"
  ],
  "RecordCount": 2,
  "IsPlaced": true,
  "ProductionComplete": true,
  "Id": "2f28105f-d392-4df9-8ca6-0abd35fb287d",
  "CreationDateUtc": "2026-01-08T10:09:57.0657229+00:00",
  "UserId": "705b6c41-3499-472e-8767-660a67dc7cc5",
  "TenantId": "8889e785-0ced-4e34-a5d5-bdd2ef56c4a6",
  "SubtotalExVat": 9.0,
  "SubtotalIncVat": 10.0,
  "DiscountedTotalExVat": 11.0,
  "DiscountedTotalIncVat": 12.0,
  "VatRateApplied": 13.0
}

application/xml, text/xml

Sample:

<DataManagementCampaignDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.DataManagement.Models">
  <CreationDateUtc xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">2026-01-08T10:09:57.0657229+00:00</CreationDateUtc>
  <DiscountedTotalExVat xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">11</DiscountedTotalExVat>
  <DiscountedTotalIncVat xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">12</DiscountedTotalIncVat>
  <Id xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">2f28105f-d392-4df9-8ca6-0abd35fb287d</Id>
  <SubtotalExVat xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">9</SubtotalExVat>
  <SubtotalIncVat xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">10</SubtotalIncVat>
  <TenantId xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">8889e785-0ced-4e34-a5d5-bdd2ef56c4a6</TenantId>
  <UserId xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">705b6c41-3499-472e-8767-660a67dc7cc5</UserId>
  <VatRateApplied xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">13</VatRateApplied>
  <DataFileIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>22f95f98-3380-41da-bb15-6f38fe44e91d</d2p1:guid>
    <d2p1:guid>54eb5172-81f9-4ac1-bcbd-f8e9d982f780</d2p1:guid>
  </DataFileIds>
  <DataListId>2a965d46-63c4-4786-ab3e-7e65a2996f60</DataListId>
  <IsPlaced>true</IsPlaced>
  <OrderId>d2592bd1-226a-4f9d-92dd-7b6d0c5779be</OrderId>
  <ProductionComplete>true</ProductionComplete>
  <RecordCount>2</RecordCount>
</DataManagementCampaignDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.