POST api/invites/persons/search

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CampaignId	globally unique identifier	None.
Id	globally unique identifier	None.
PersonId	globally unique identifier	None.
PromotionalEventId	globally unique identifier	None.
AppointmentStartBefore	date	None.
AppointmentStartAfter	date	None.
EventStartBefore	date	None.
EventStartAfter	date	None.
Booked	boolean	None.
Attended	boolean	None.
Purchased	boolean	None.
InteractionCriteria	CommunicationInteractionCriteriaDto	None.
AddressStatusCriteria	AddressStatusCriteriaDto	None.
ReceiveSmsCommunications	boolean	None.
ReceiveEmailCommunications	boolean	None.
ReceiveMailCommunications	boolean	None.
WithAddressPropertyNames	Collection of string	None.
WithAddressPropertyValues	Collection of string	None.
HasEmailAddress	boolean	None.
HasTelephone	boolean	None.
HasPostalCode	boolean	None.
IsDeleted	boolean	None.
SecurityGroupIds	Collection of globally unique identifier	None.
Pagination	PaginationCriteriaDto	None.

Request Formats

application/json, text/json

Sample:

{
  "CampaignId": "6bd752a0-5670-4608-9a55-4ecf27debbc9",
  "Id": "bf9b50ec-4c16-4e1a-9aa5-39f12fd358da",
  "PersonId": "13fd9653-a349-4223-b569-54254c410586",
  "PromotionalEventId": "0387440d-d8c7-4a81-b7b4-003db6bac4d2",
  "AppointmentStartBefore": "2026-01-09T14:12:24.0083867+00:00",
  "AppointmentStartAfter": "2026-01-09T14:12:24.0083867+00:00",
  "EventStartBefore": "2026-01-09T14:12:24.0083867+00:00",
  "EventStartAfter": "2026-01-09T14:12:24.0083867+00:00",
  "Booked": true,
  "Attended": true,
  "Purchased": true,
  "InteractionCriteria": {
    "CommunicationId": "7be8af3c-9fa9-42ec-b8ed-f92f8b6ade9d",
    "InteractionType": 0,
    "InteractionTypeNot": 0
  },
  "AddressStatusCriteria": {
    "AddressStatus": 0,
    "AddressStatusNot": 0
  },
  "ReceiveSmsCommunications": true,
  "ReceiveEmailCommunications": true,
  "ReceiveMailCommunications": true,
  "WithAddressPropertyNames": [
    "sample string 1",
    "sample string 2"
  ],
  "WithAddressPropertyValues": [
    "sample string 1",
    "sample string 2"
  ],
  "HasEmailAddress": true,
  "HasTelephone": true,
  "HasPostalCode": true,
  "IsDeleted": true,
  "SecurityGroupIds": [
    "eb418839-8245-4ecd-ace7-1e3b95cf6852",
    "26458ae8-9839-4eaf-b925-3b59d9afec5b"
  ],
  "Pagination": {
    "PageNumber": 1,
    "PageSize": 1
  }
}

application/xml, text/xml

Sample:

<InviteCriteriaDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.EventManagement.Models">
  <AddressStatusCriteria>
    <AddressStatus>Ok</AddressStatus>
    <AddressStatusNot>Ok</AddressStatusNot>
  </AddressStatusCriteria>
  <AppointmentStartAfter>2026-01-09T14:12:24.0083867+00:00</AppointmentStartAfter>
  <AppointmentStartBefore>2026-01-09T14:12:24.0083867+00:00</AppointmentStartBefore>
  <Attended>true</Attended>
  <Booked>true</Booked>
  <CampaignId>6bd752a0-5670-4608-9a55-4ecf27debbc9</CampaignId>
  <EventStartAfter>2026-01-09T14:12:24.0083867+00:00</EventStartAfter>
  <EventStartBefore>2026-01-09T14:12:24.0083867+00:00</EventStartBefore>
  <HasEmailAddress>true</HasEmailAddress>
  <HasPostalCode>true</HasPostalCode>
  <HasTelephone>true</HasTelephone>
  <Id>bf9b50ec-4c16-4e1a-9aa5-39f12fd358da</Id>
  <InteractionCriteria>
    <CommunicationId>7be8af3c-9fa9-42ec-b8ed-f92f8b6ade9d</CommunicationId>
    <InteractionType>Undefined</InteractionType>
    <InteractionTypeNot>Undefined</InteractionTypeNot>
  </InteractionCriteria>
  <IsDeleted>true</IsDeleted>
  <Pagination>
    <PageNumber>1</PageNumber>
    <PageSize>1</PageSize>
  </Pagination>
  <PersonId>13fd9653-a349-4223-b569-54254c410586</PersonId>
  <PromotionalEventId>0387440d-d8c7-4a81-b7b4-003db6bac4d2</PromotionalEventId>
  <Purchased>true</Purchased>
  <ReceiveEmailCommunications>true</ReceiveEmailCommunications>
  <ReceiveMailCommunications>true</ReceiveMailCommunications>
  <ReceiveSmsCommunications>true</ReceiveSmsCommunications>
  <SecurityGroupIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>eb418839-8245-4ecd-ace7-1e3b95cf6852</d2p1:guid>
    <d2p1:guid>26458ae8-9839-4eaf-b925-3b59d9afec5b</d2p1:guid>
  </SecurityGroupIds>
  <WithAddressPropertyNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WithAddressPropertyNames>
  <WithAddressPropertyValues xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WithAddressPropertyValues>
</InviteCriteriaDto>

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.