PUT api/communications/{id}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
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": "c8daebc2-9c73-4188-a980-cf36bea55622",
"CreationDate": "2026-01-10T00:55:55.7241214+00:00",
"Name": "sample string 3",
"CommunicationType": 0,
"CommunicationStatus": 0,
"LeadUpDuration": 4,
"TemplateId": "8021634f-be46-4b02-90fe-3b521d8e27c8",
"TemplateName": "sample string 5",
"Subject": "sample string 6",
"CampaignId": "1a1da516-d0ef-44bc-8d38-5185e52a48e8",
"IsDeleted": true,
"CommunicationTemplateId": "5e9a7ad8-fe4b-48b3-b3e2-7ab2dea68188",
"IncludeBooked": true,
"IncludeAttended": true,
"IncludePurchased": true,
"EmailCommunicationId": "828ebba0-8b27-4ac8-a583-fb6684ce86be"
}
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>1a1da516-d0ef-44bc-8d38-5185e52a48e8</CampaignId> <CommunicationStatus>Pending</CommunicationStatus> <CommunicationTemplateId>5e9a7ad8-fe4b-48b3-b3e2-7ab2dea68188</CommunicationTemplateId> <CommunicationType>DirectMail</CommunicationType> <CreationDate>2026-01-10T00:55:55.7241214+00:00</CreationDate> <EmailCommunicationId>828ebba0-8b27-4ac8-a583-fb6684ce86be</EmailCommunicationId> <Id>c8daebc2-9c73-4188-a980-cf36bea55622</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>8021634f-be46-4b02-90fe-3b521d8e27c8</TemplateId> <TemplateName>sample string 5</TemplateName> </CommunicationDto>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
None.