PUT api/communications/{id}
Updates a communication from the given .
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The id of the resource. |
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": "a9958a30-8ae7-4dab-9a3e-0d1242f4a9f2",
"CreationDate": "2026-01-09T14:10:36.627933+00:00",
"Name": "sample string 3",
"CommunicationType": 0,
"CommunicationStatus": 0,
"LeadUpDuration": 4,
"TemplateId": "b9aef844-edaf-4451-88bc-7859f0ebb433",
"TemplateName": "sample string 5",
"Subject": "sample string 6",
"CampaignId": "ccf4bbf9-f875-4fde-8111-0ebcc6068500",
"IsDeleted": true,
"CommunicationTemplateId": "b112fd90-93e8-49f8-a730-912d13fd81f4",
"IncludeBooked": true,
"IncludeAttended": true,
"IncludePurchased": true,
"EmailCommunicationId": "730e47ca-d136-4af2-b07a-115fcbe801b0"
}
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>ccf4bbf9-f875-4fde-8111-0ebcc6068500</CampaignId> <CommunicationStatus>Pending</CommunicationStatus> <CommunicationTemplateId>b112fd90-93e8-49f8-a730-912d13fd81f4</CommunicationTemplateId> <CommunicationType>DirectMail</CommunicationType> <CreationDate>2026-01-09T14:10:36.627933+00:00</CreationDate> <EmailCommunicationId>730e47ca-d136-4af2-b07a-115fcbe801b0</EmailCommunicationId> <Id>a9958a30-8ae7-4dab-9a3e-0d1242f4a9f2</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>b9aef844-edaf-4451-88bc-7859f0ebb433</TemplateId> <TemplateName>sample string 5</TemplateName> </CommunicationDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.