POST api/communications
Request Information
URI Parameters
None.
Body Parameters
CommunicationDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| CreationDate | date |
None. |
|
| Name | string |
None. |
|
| CommunicationType | CommunicationDtoType |
None. |
|
| CommunicationStatus | CommunicationDtoStatus |
None. |
|
| LeadUpDuration | integer |
None. |
|
| TemplateId | globally unique identifier |
None. |
|
| TemplateName | string |
None. |
|
| Subject | string |
None. |
|
| CampaignId | globally unique identifier |
None. |
|
| IsDeleted | boolean |
None. |
|
| CommunicationTemplateId | globally unique identifier |
None. |
|
| IncludeBooked | boolean |
None. |
|
| IncludeAttended | boolean |
None. |
|
| IncludePurchased | boolean |
None. |
|
| EmailCommunicationId | globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": "1d6187bc-6665-4b56-a6b1-c533f0f53643",
"CreationDate": "2026-01-10T10:22:06.4317584+00:00",
"Name": "sample string 3",
"CommunicationType": 0,
"CommunicationStatus": 0,
"LeadUpDuration": 4,
"TemplateId": "1f1cea68-9cbe-4c4d-90c7-dc94596af036",
"TemplateName": "sample string 5",
"Subject": "sample string 6",
"CampaignId": "44ad1840-54d3-45d6-825f-27cf483b08ac",
"IsDeleted": true,
"CommunicationTemplateId": "283d99e4-4003-405f-a31e-ed90b18d5934",
"IncludeBooked": true,
"IncludeAttended": true,
"IncludePurchased": true,
"EmailCommunicationId": "3433476a-20fa-4045-8613-c201477ccf4b"
}
application/xml, text/xml
Sample:
<CommunicationDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.EventManagement.Models"> <CampaignId>44ad1840-54d3-45d6-825f-27cf483b08ac</CampaignId> <CommunicationStatus>Pending</CommunicationStatus> <CommunicationTemplateId>283d99e4-4003-405f-a31e-ed90b18d5934</CommunicationTemplateId> <CommunicationType>DirectMail</CommunicationType> <CreationDate>2026-01-10T10:22:06.4317584+00:00</CreationDate> <EmailCommunicationId>3433476a-20fa-4045-8613-c201477ccf4b</EmailCommunicationId> <Id>1d6187bc-6665-4b56-a6b1-c533f0f53643</Id> <IncludeAttended>true</IncludeAttended> <IncludeBooked>true</IncludeBooked> <IncludePurchased>true</IncludePurchased> <IsDeleted>true</IsDeleted> <LeadUpDuration>4</LeadUpDuration> <Name>sample string 3</Name> <Subject>sample string 6</Subject> <TemplateId>1f1cea68-9cbe-4c4d-90c7-dc94596af036</TemplateId> <TemplateName>sample string 5</TemplateName> </CommunicationDto>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
None.