PUT api/Campaigns/{id}

Updates a campaign.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The id of the campaign to update.	globally unique identifier	Required

Body Parameters

The campaign model to update with.

TargetCampaignDto

Name	Type	Additional information
OrderId	globally unique identifier	None.
Areas	Collection of AreaDto	None.
DeliveryDate	date	None.
EarliestHandoverDate	date	None.
LatestHandoverDate	date	None.
DeliverAsap	boolean	None.
ScheduleCronExpression	string	None.
ScheduleStartDate	date	None.
ScheduleEndDate	date	None.
DistributionSets	Collection of DistributionSetDto	None.
ModifiedDateUtc	date	None.
MinimumOrderedQuantity	integer	None.
PropKey	string	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": "d3993543-d931-4d7f-bc7d-46dcfe70be0f",
  "Areas": [
    {
      "AreaName": "sample string 1",
      "Sectors": [
        "sample string 1",
        "sample string 2"
      ],
      "Volume": 2,
      "Price": 3.0,
      "SelectedLifeStages": "sample string 4",
      "FamilyTypes": "sample string 5",
      "IncomeBrackets": "sample string 6",
      "SelectedRadius": 7.0,
      "SearchKey": "sample string 8",
      "DisplayName": "sample string 9"
    },
    {
      "AreaName": "sample string 1",
      "Sectors": [
        "sample string 1",
        "sample string 2"
      ],
      "Volume": 2,
      "Price": 3.0,
      "SelectedLifeStages": "sample string 4",
      "FamilyTypes": "sample string 5",
      "IncomeBrackets": "sample string 6",
      "SelectedRadius": 7.0,
      "SearchKey": "sample string 8",
      "DisplayName": "sample string 9"
    }
  ],
  "DeliveryDate": "2025-12-06T02:32:42.1792036+00:00",
  "EarliestHandoverDate": "2025-12-06T02:32:42.1792036+00:00",
  "LatestHandoverDate": "2025-12-06T02:32:42.1792036+00:00",
  "DeliverAsap": true,
  "ScheduleCronExpression": "sample string 3",
  "ScheduleStartDate": "2025-12-06T02:32:42.1792036+00:00",
  "ScheduleEndDate": "2025-12-06T02:32:42.1792036+00:00",
  "DistributionSets": [
    {
      "DepotId": 1,
      "DistributionSite": "sample string 2",
      "DistributionVolume": 3
    },
    {
      "DepotId": 1,
      "DistributionSite": "sample string 2",
      "DistributionVolume": 3
    }
  ],
  "ModifiedDateUtc": "2025-12-06T02:32:42.1792036+00:00",
  "MinimumOrderedQuantity": 4,
  "PropKey": "sample string 5",
  "Id": "a0efec4c-7cec-4e70-b0f3-bb913cff2672",
  "CreationDateUtc": "2025-12-06T02:32:42.1792036+00:00",
  "UserId": "67f8295d-25f7-4904-828a-a5e78da18172",
  "TenantId": "c69a3297-ae52-42ee-a22c-55a54aa3a1d3",
  "SubtotalExVat": 10.0,
  "SubtotalIncVat": 11.0,
  "DiscountedTotalExVat": 12.0,
  "DiscountedTotalIncVat": 13.0,
  "VatRateApplied": 14.0
}

application/xml, text/xml

Sample:

<TargetCampaignDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Target.Models">
  <CreationDateUtc xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">2025-12-06T02:32:42.1792036+00:00</CreationDateUtc>
  <DiscountedTotalExVat xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">12</DiscountedTotalExVat>
  <DiscountedTotalIncVat xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">13</DiscountedTotalIncVat>
  <Id xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">a0efec4c-7cec-4e70-b0f3-bb913cff2672</Id>
  <SubtotalExVat xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">10</SubtotalExVat>
  <SubtotalIncVat xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">11</SubtotalIncVat>
  <TenantId xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">c69a3297-ae52-42ee-a22c-55a54aa3a1d3</TenantId>
  <UserId xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">67f8295d-25f7-4904-828a-a5e78da18172</UserId>
  <VatRateApplied xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">14</VatRateApplied>
  <Areas>
    <AreaDto>
      <AreaName>sample string 1</AreaName>
      <DisplayName>sample string 9</DisplayName>
      <FamilyTypes>sample string 5</FamilyTypes>
      <IncomeBrackets>sample string 6</IncomeBrackets>
      <Price>3</Price>
      <SearchKey>sample string 8</SearchKey>
      <Sectors xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Sectors>
      <SelectedLifeStages>sample string 4</SelectedLifeStages>
      <SelectedRadius>7</SelectedRadius>
      <Volume>2</Volume>
    </AreaDto>
    <AreaDto>
      <AreaName>sample string 1</AreaName>
      <DisplayName>sample string 9</DisplayName>
      <FamilyTypes>sample string 5</FamilyTypes>
      <IncomeBrackets>sample string 6</IncomeBrackets>
      <Price>3</Price>
      <SearchKey>sample string 8</SearchKey>
      <Sectors xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Sectors>
      <SelectedLifeStages>sample string 4</SelectedLifeStages>
      <SelectedRadius>7</SelectedRadius>
      <Volume>2</Volume>
    </AreaDto>
  </Areas>
  <DeliverAsap>true</DeliverAsap>
  <DeliveryDate>2025-12-06T02:32:42.1792036+00:00</DeliveryDate>
  <DistributionSets>
    <DistributionSetDto>
      <DepotId>1</DepotId>
      <DistributionSite>sample string 2</DistributionSite>
      <DistributionVolume>3</DistributionVolume>
    </DistributionSetDto>
    <DistributionSetDto>
      <DepotId>1</DepotId>
      <DistributionSite>sample string 2</DistributionSite>
      <DistributionVolume>3</DistributionVolume>
    </DistributionSetDto>
  </DistributionSets>
  <EarliestHandoverDate>2025-12-06T02:32:42.1792036+00:00</EarliestHandoverDate>
  <LatestHandoverDate>2025-12-06T02:32:42.1792036+00:00</LatestHandoverDate>
  <MinimumOrderedQuantity>4</MinimumOrderedQuantity>
  <ModifiedDateUtc>2025-12-06T02:32:42.1792036+00:00</ModifiedDateUtc>
  <OrderId>d3993543-d931-4d7f-bc7d-46dcfe70be0f</OrderId>
  <PropKey>sample string 5</PropKey>
  <ScheduleCronExpression>sample string 3</ScheduleCronExpression>
  <ScheduleEndDate>2025-12-06T02:32:42.1792036+00:00</ScheduleEndDate>
  <ScheduleStartDate>2025-12-06T02:32:42.1792036+00:00</ScheduleStartDate>
</TargetCampaignDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.