POST api/communications
Creates a communication from the given .
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": "ab451588-8c9a-4610-ad55-bd810496f2fa",
"CreationDate": "2025-12-11T00:41:45.2352124+00:00",
"Name": "sample string 3",
"CommunicationType": 0,
"CommunicationStatus": 0,
"LeadUpDuration": 4,
"TemplateId": "6c1c0bd5-04b9-481e-a1a3-f60675e33ebf",
"TemplateName": "sample string 5",
"Subject": "sample string 6",
"CampaignId": "7301bf67-e068-49c3-adb2-e51832cc6c5d",
"IsDeleted": true,
"CommunicationTemplateId": "d9d99477-8faa-4807-a7eb-811bed02dbfb",
"IncludeBooked": true,
"IncludeAttended": true,
"IncludePurchased": true,
"EmailCommunicationId": "d2e91b2d-a207-4d12-a191-932839c109fc"
}
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>7301bf67-e068-49c3-adb2-e51832cc6c5d</CampaignId> <CommunicationStatus>Pending</CommunicationStatus> <CommunicationTemplateId>d9d99477-8faa-4807-a7eb-811bed02dbfb</CommunicationTemplateId> <CommunicationType>DirectMail</CommunicationType> <CreationDate>2025-12-11T00:41:45.2352124+00:00</CreationDate> <EmailCommunicationId>d2e91b2d-a207-4d12-a191-932839c109fc</EmailCommunicationId> <Id>ab451588-8c9a-4610-ad55-bd810496f2fa</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>6c1c0bd5-04b9-481e-a1a3-f60675e33ebf</TemplateId> <TemplateName>sample string 5</TemplateName> </CommunicationDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.