POST api/campaigns/select

Retrieves a list of campaigns that match the given criteria.

Request Information

URI Parameters

None.

Body Parameters

The criteria model to filter campaigns by.

Name	Type	Additional information
Id	globally unique identifier	None.
Name	string	None.
TenantId	globally unique identifier	None.
UserId	globally unique identifier	None.
SearchQuery	string	None.
IsTemporary	boolean	None.
Completed	boolean	None.
OrderStatus	string	None.
UserJourney	string	None.
CreationDateStartUtc	date	None.
CreationDateEndUtc	date	None.
ModifiedDateStartUtc	date	None.
ModifiedDateEndUtc	date	None.
PaymentDateStartUtc	date	None.
PaymentDateEndUtc	date	None.
SupplierIds	Collection of globally unique identifier	None.
VoucherId	integer	None.
OrganisationId	globally unique identifier	None.
CentralMailerCampaignId	globally unique identifier	None.
OrgIds	Collection of globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "97f13ba1-91b7-4557-9dcf-9c99052a19a2",
  "Name": "sample string 1",
  "TenantId": "74722050-f77c-47ec-b8c8-ee6ba7df8d74",
  "UserId": "0a21ea49-56e8-4e31-8040-06f24dc2c151",
  "SearchQuery": "sample string 2",
  "IsTemporary": true,
  "Completed": true,
  "OrderStatus": "sample string 3",
  "UserJourney": "sample string 4",
  "CreationDateStartUtc": "2026-08-28T13:48:23.1182847+00:00",
  "CreationDateEndUtc": "2026-08-28T13:48:23.1182847+00:00",
  "ModifiedDateStartUtc": "2026-08-28T13:48:23.1182847+00:00",
  "ModifiedDateEndUtc": "2026-08-28T13:48:23.1182847+00:00",
  "PaymentDateStartUtc": "2026-08-28T13:48:23.1182847+00:00",
  "PaymentDateEndUtc": "2026-08-28T13:48:23.1182847+00:00",
  "SupplierIds": [
    "ef88b426-e873-4e36-a0b1-95cf5fdcd7e6",
    "6f6f1d3c-df63-4640-89db-4a9764c8fa41"
  ],
  "VoucherId": 1,
  "OrganisationId": "8d081ef4-279d-4e2f-9827-e5896736e019",
  "CentralMailerCampaignId": "c56e6ad9-2da3-4cc1-9940-1a4ad807f311",
  "OrgIds": [
    "7a9e862c-06bf-4389-a9e3-3943c7f60ff8",
    "434fcb62-af6a-435a-8f17-fc6eaa06810f"
  ]
}

application/xml, text/xml

Sample:

<PayCampaignFilterCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Pay.Models.FilterCriteria">
  <CentralMailerCampaignId>c56e6ad9-2da3-4cc1-9940-1a4ad807f311</CentralMailerCampaignId>
  <Completed>true</Completed>
  <CreationDateEndUtc>2026-08-28T13:48:23.1182847+00:00</CreationDateEndUtc>
  <CreationDateStartUtc>2026-08-28T13:48:23.1182847+00:00</CreationDateStartUtc>
  <Id>97f13ba1-91b7-4557-9dcf-9c99052a19a2</Id>
  <IsTemporary>true</IsTemporary>
  <ModifiedDateEndUtc>2026-08-28T13:48:23.1182847+00:00</ModifiedDateEndUtc>
  <ModifiedDateStartUtc>2026-08-28T13:48:23.1182847+00:00</ModifiedDateStartUtc>
  <Name>sample string 1</Name>
  <OrderStatus>sample string 3</OrderStatus>
  <OrgIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>7a9e862c-06bf-4389-a9e3-3943c7f60ff8</d2p1:guid>
    <d2p1:guid>434fcb62-af6a-435a-8f17-fc6eaa06810f</d2p1:guid>
  </OrgIds>
  <OrganisationId>8d081ef4-279d-4e2f-9827-e5896736e019</OrganisationId>
  <PaymentDateEndUtc>2026-08-28T13:48:23.1182847+00:00</PaymentDateEndUtc>
  <PaymentDateStartUtc>2026-08-28T13:48:23.1182847+00:00</PaymentDateStartUtc>
  <SearchQuery>sample string 2</SearchQuery>
  <SupplierIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>ef88b426-e873-4e36-a0b1-95cf5fdcd7e6</d2p1:guid>
    <d2p1:guid>6f6f1d3c-df63-4640-89db-4a9764c8fa41</d2p1:guid>
  </SupplierIds>
  <TenantId>74722050-f77c-47ec-b8c8-ee6ba7df8d74</TenantId>
  <UserId>0a21ea49-56e8-4e31-8040-06f24dc2c151</UserId>
  <UserJourney>sample string 4</UserJourney>
  <VoucherId>1</VoucherId>
</PayCampaignFilterCriteria>

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.