POST api/Campaigns

Creates a campaign.

Request Information

URI Parameters

None.

Body Parameters

The campaign model to create with.

Name	Type	Additional information
Name	string	None.
PublicId	string	None.
ModifiedDateUtc	date	None.
UserJourney	string	None.
ServiceType	ServiceTypeDto	None.
Quantity	integer	None.
ApprovalResponses	Collection of ApprovalResponseDto	None.
SupplierId	globally unique identifier	None.
OrderId	globally unique identifier	None.
CampaignProperties	Collection of PayCampaignPropertyDto	None.
Voucher	VoucherDto	None.
OrderStatusChanges	Collection of StatusChangeDto	None.
OrderStatus	string	None.
IsTemporary	boolean	None.
RB_ArtWorkToken	string	None.
PR_Key	string	None.
PR_UDPRN	string	None.
Ext_TemplateId	integer	None.
Ext_ArtworkId	integer	None.
Ext_ResourceId	integer	None.
FileLocation	string	None.
OrganisationId	globally unique identifier	None.
OrganisationName	string	None.
TemplateName	string	None.
UserName	string	None.
Ext_MailerType	string	None.
Envelope	string	None.
Variant	string	None.
ApprovalGroupId	globally unique identifier	None.
DeliveryDate	date	None.
PaperSize	string	None.
CentralMailerCampaignId	globally unique identifier	None.
OrderProductionCompletedDate	date	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:

{
  "Name": "sample string 1",
  "PublicId": "sample string 2",
  "ModifiedDateUtc": "2025-12-06T02:25:04.6776407+00:00",
  "UserJourney": "sample string 3",
  "ServiceType": 0,
  "Quantity": 4,
  "ApprovalResponses": [
    {
      "Id": "1ec33891-aff3-4f79-9288-0deb7461561c",
      "CreationDate": "2025-12-06T02:25:04.6776407+00:00",
      "ApproverUserId": "e088f584-3857-4697-ab02-0a90447edb73",
      "Note": "sample string 4",
      "Status": 0,
      "CampaignId": "3be51ee2-29cc-4af6-b82e-9c4fc31f128a"
    },
    {
      "Id": "1ec33891-aff3-4f79-9288-0deb7461561c",
      "CreationDate": "2025-12-06T02:25:04.6776407+00:00",
      "ApproverUserId": "e088f584-3857-4697-ab02-0a90447edb73",
      "Note": "sample string 4",
      "Status": 0,
      "CampaignId": "3be51ee2-29cc-4af6-b82e-9c4fc31f128a"
    }
  ],
  "SupplierId": "ad6c55ec-cf48-41d8-85c3-be3849965125",
  "OrderId": "2593bde4-9a77-47cc-8fea-da02ef8d1c05",
  "CampaignProperties": [
    {
      "Id": "aecdba85-335f-432f-ab42-48f7dd5ef693",
      "CampaignId": "07207638-6295-4204-be92-7653162d0b21",
      "Name": "sample string 3",
      "Value": "sample string 4"
    },
    {
      "Id": "aecdba85-335f-432f-ab42-48f7dd5ef693",
      "CampaignId": "07207638-6295-4204-be92-7653162d0b21",
      "Name": "sample string 3",
      "Value": "sample string 4"
    }
  ],
  "Voucher": {
    "Id": 1,
    "Description": "sample string 2",
    "VoucherCode": "sample string 3",
    "TenantId": "sample string 4",
    "StartDate": "2025-12-06T02:25:04.6776407+00:00",
    "ExpiryDate": "2025-12-06T02:25:04.6776407+00:00",
    "Cancelled": true,
    "IsPercentageDiscount": true,
    "Entitlement": 7.0,
    "MinSpend": 1.0,
    "MaxSpend": 1.0,
    "MaxDiscount": 1.0,
    "ForAllUsers": true,
    "Deleted": true,
    "VoucherUsers": [
      {
        "UserId": "d361ba5c-2bc7-4738-bedb-0200fb0894dd",
        "SingleUse": true,
        "ApplyAutomatically": true
      },
      {
        "UserId": "d361ba5c-2bc7-4738-bedb-0200fb0894dd",
        "SingleUse": true,
        "ApplyAutomatically": true
      }
    ],
    "MinimumQuantity": 1,
    "VoucherProductType": "sample string 10",
    "NewCustomerOnly": true,
    "VoucherProperties": [
      {
        "Id": "717ad872-fa51-4812-b2c1-0a5bf728fc68",
        "CreationDateUtc": "2025-12-06T02:25:04.6776407+00:00",
        "VoucherId": 3,
        "Name": "sample string 4",
        "Value": "sample string 5",
        "Type": 0
      },
      {
        "Id": "717ad872-fa51-4812-b2c1-0a5bf728fc68",
        "CreationDateUtc": "2025-12-06T02:25:04.6776407+00:00",
        "VoucherId": 3,
        "Name": "sample string 4",
        "Value": "sample string 5",
        "Type": 0
      }
    ]
  },
  "OrderStatusChanges": [
    {
      "Id": 1,
      "Status": "sample string 2",
      "ChangeDateUtc": "2025-12-06T02:25:04.6776407+00:00",
      "Description": "sample string 4",
      "UserId": "1f4ddb27-994c-47c6-beb2-443101c970b1"
    },
    {
      "Id": 1,
      "Status": "sample string 2",
      "ChangeDateUtc": "2025-12-06T02:25:04.6776407+00:00",
      "Description": "sample string 4",
      "UserId": "1f4ddb27-994c-47c6-beb2-443101c970b1"
    }
  ],
  "OrderStatus": "sample string 2",
  "IsTemporary": true,
  "RB_ArtWorkToken": "sample string 7",
  "PR_Key": "sample string 8",
  "PR_UDPRN": "sample string 9",
  "Ext_TemplateId": 1,
  "Ext_ArtworkId": 1,
  "Ext_ResourceId": 1,
  "FileLocation": "sample string 10",
  "OrganisationId": "bf4a985e-0f97-4311-b900-9596f11ad4f1",
  "OrganisationName": "sample string 11",
  "TemplateName": "sample string 12",
  "UserName": "sample string 13",
  "Ext_MailerType": "sample string 14",
  "Envelope": "sample string 15",
  "Variant": "sample string 16",
  "ApprovalGroupId": "b8dbaaf9-0675-40c6-b2d7-2d03c6da244f",
  "DeliveryDate": "2025-12-06T02:25:04.6776407+00:00",
  "PaperSize": "sample string 17",
  "CentralMailerCampaignId": "88dbab8a-9219-43dd-a3e1-f0840a103f5c",
  "OrderProductionCompletedDate": null,
  "Id": "fd11a1b2-5955-48a7-b427-da6ede3b45a0",
  "CreationDateUtc": "2025-12-06T02:25:04.6776407+00:00",
  "UserId": "dba3550d-8e92-4023-98e6-a44e5759e073",
  "TenantId": "71070da7-f644-4b92-a882-1293d553b06e",
  "SubtotalExVat": 22.0,
  "SubtotalIncVat": 23.0,
  "DiscountedTotalExVat": 24.0,
  "DiscountedTotalIncVat": 25.0,
  "VatRateApplied": 26.0
}

application/xml, text/xml

Sample:

<PayCampaignDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Pay.Models">
  <CreationDateUtc xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">2025-12-06T02:25:04.6776407+00:00</CreationDateUtc>
  <DiscountedTotalExVat xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">24</DiscountedTotalExVat>
  <DiscountedTotalIncVat xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">25</DiscountedTotalIncVat>
  <Id xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">fd11a1b2-5955-48a7-b427-da6ede3b45a0</Id>
  <SubtotalExVat xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">22</SubtotalExVat>
  <SubtotalIncVat xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">23</SubtotalIncVat>
  <TenantId xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">71070da7-f644-4b92-a882-1293d553b06e</TenantId>
  <UserId xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">dba3550d-8e92-4023-98e6-a44e5759e073</UserId>
  <VatRateApplied xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Library.ServiceModels.DataTransferObjects">26</VatRateApplied>
  <ApprovalGroupId>b8dbaaf9-0675-40c6-b2d7-2d03c6da244f</ApprovalGroupId>
  <ApprovalResponses>
    <ApprovalResponseDto>
      <ApproverUserId>e088f584-3857-4697-ab02-0a90447edb73</ApproverUserId>
      <CampaignId>3be51ee2-29cc-4af6-b82e-9c4fc31f128a</CampaignId>
      <CreationDate>2025-12-06T02:25:04.6776407+00:00</CreationDate>
      <Id>1ec33891-aff3-4f79-9288-0deb7461561c</Id>
      <Note>sample string 4</Note>
      <Status>Approved</Status>
    </ApprovalResponseDto>
    <ApprovalResponseDto>
      <ApproverUserId>e088f584-3857-4697-ab02-0a90447edb73</ApproverUserId>
      <CampaignId>3be51ee2-29cc-4af6-b82e-9c4fc31f128a</CampaignId>
      <CreationDate>2025-12-06T02:25:04.6776407+00:00</CreationDate>
      <Id>1ec33891-aff3-4f79-9288-0deb7461561c</Id>
      <Note>sample string 4</Note>
      <Status>Approved</Status>
    </ApprovalResponseDto>
  </ApprovalResponses>
  <CampaignProperties>
    <PayCampaignPropertyDto>
      <CampaignId>07207638-6295-4204-be92-7653162d0b21</CampaignId>
      <Id>aecdba85-335f-432f-ab42-48f7dd5ef693</Id>
      <Name>sample string 3</Name>
      <Value>sample string 4</Value>
    </PayCampaignPropertyDto>
    <PayCampaignPropertyDto>
      <CampaignId>07207638-6295-4204-be92-7653162d0b21</CampaignId>
      <Id>aecdba85-335f-432f-ab42-48f7dd5ef693</Id>
      <Name>sample string 3</Name>
      <Value>sample string 4</Value>
    </PayCampaignPropertyDto>
  </CampaignProperties>
  <CentralMailerCampaignId>88dbab8a-9219-43dd-a3e1-f0840a103f5c</CentralMailerCampaignId>
  <DeliveryDate>2025-12-06T02:25:04.6776407+00:00</DeliveryDate>
  <Envelope>sample string 15</Envelope>
  <Ext_ArtworkId>1</Ext_ArtworkId>
  <Ext_MailerType>sample string 14</Ext_MailerType>
  <Ext_ResourceId>1</Ext_ResourceId>
  <Ext_TemplateId>1</Ext_TemplateId>
  <FileLocation>sample string 10</FileLocation>
  <IsTemporary>true</IsTemporary>
  <ModifiedDateUtc>2025-12-06T02:25:04.6776407+00:00</ModifiedDateUtc>
  <Name>sample string 1</Name>
  <OrderId>2593bde4-9a77-47cc-8fea-da02ef8d1c05</OrderId>
  <OrderStatusChanges>
    <StatusChangeDto>
      <ChangeDateUtc>2025-12-06T02:25:04.6776407+00:00</ChangeDateUtc>
      <Description>sample string 4</Description>
      <Id>1</Id>
      <Status>sample string 2</Status>
      <UserId>1f4ddb27-994c-47c6-beb2-443101c970b1</UserId>
    </StatusChangeDto>
    <StatusChangeDto>
      <ChangeDateUtc>2025-12-06T02:25:04.6776407+00:00</ChangeDateUtc>
      <Description>sample string 4</Description>
      <Id>1</Id>
      <Status>sample string 2</Status>
      <UserId>1f4ddb27-994c-47c6-beb2-443101c970b1</UserId>
    </StatusChangeDto>
  </OrderStatusChanges>
  <OrganisationId>bf4a985e-0f97-4311-b900-9596f11ad4f1</OrganisationId>
  <OrganisationName>sample string 11</OrganisationName>
  <PR_Key>sample string 8</PR_Key>
  <PR_UDPRN>sample string 9</PR_UDPRN>
  <PaperSize>sample string 17</PaperSize>
  <PublicId>sample string 2</PublicId>
  <Quantity>4</Quantity>
  <RB_ArtWorkToken>sample string 7</RB_ArtWorkToken>
  <ServiceType>DesignPrintAndDistribution</ServiceType>
  <SupplierId>ad6c55ec-cf48-41d8-85c3-be3849965125</SupplierId>
  <TemplateName>sample string 12</TemplateName>
  <UserJourney>sample string 3</UserJourney>
  <UserName>sample string 13</UserName>
  <Variant>sample string 16</Variant>
  <Voucher>
    <Cancelled>true</Cancelled>
    <Deleted>true</Deleted>
    <Description>sample string 2</Description>
    <Entitlement>7</Entitlement>
    <ExpiryDate>2025-12-06T02:25:04.6776407+00:00</ExpiryDate>
    <ForAllUsers>true</ForAllUsers>
    <Id>1</Id>
    <IsPercentageDiscount>true</IsPercentageDiscount>
    <MaxDiscount>1</MaxDiscount>
    <MaxSpend>1</MaxSpend>
    <MinSpend>1</MinSpend>
    <MinimumQuantity>1</MinimumQuantity>
    <NewCustomerOnly>true</NewCustomerOnly>
    <StartDate>2025-12-06T02:25:04.6776407+00:00</StartDate>
    <TenantId>sample string 4</TenantId>
    <VoucherCode>sample string 3</VoucherCode>
    <VoucherProductType>sample string 10</VoucherProductType>
    <VoucherProperties>
      <VoucherPropertyDto>
        <CreationDateUtc>2025-12-06T02:25:04.6776407+00:00</CreationDateUtc>
        <Id>717ad872-fa51-4812-b2c1-0a5bf728fc68</Id>
        <Name>sample string 4</Name>
        <Type>PrintingOptions</Type>
        <Value>sample string 5</Value>
        <VoucherId>3</VoucherId>
      </VoucherPropertyDto>
      <VoucherPropertyDto>
        <CreationDateUtc>2025-12-06T02:25:04.6776407+00:00</CreationDateUtc>
        <Id>717ad872-fa51-4812-b2c1-0a5bf728fc68</Id>
        <Name>sample string 4</Name>
        <Type>PrintingOptions</Type>
        <Value>sample string 5</Value>
        <VoucherId>3</VoucherId>
      </VoucherPropertyDto>
    </VoucherProperties>
    <VoucherUsers>
      <VoucherUserDto>
        <ApplyAutomatically>true</ApplyAutomatically>
        <SingleUse>true</SingleUse>
        <UserId>d361ba5c-2bc7-4738-bedb-0200fb0894dd</UserId>
      </VoucherUserDto>
      <VoucherUserDto>
        <ApplyAutomatically>true</ApplyAutomatically>
        <SingleUse>true</SingleUse>
        <UserId>d361ba5c-2bc7-4738-bedb-0200fb0894dd</UserId>
      </VoucherUserDto>
    </VoucherUsers>
  </Voucher>
</PayCampaignDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.