PUT api/Templates/{id}
Updates a template.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The id of the template to update. |
globally unique identifier |
Required |
Body Parameters
The template model to update with.
TemplateDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| TemplateCode | globally unique identifier |
None. |
|
| Name | string |
Required String length: inclusive between 0 and 250 |
|
| Description | string |
None. |
|
| CreationDate | date |
None. |
|
| UserId | globally unique identifier |
None. |
|
| TenantId | globally unique identifier |
None. |
|
| TenantName | string |
None. |
|
| PublishDate | date |
None. |
|
| DeletedDate | date |
None. |
|
| Version | string |
None. |
|
| WorkflowDefinitionId | globally unique identifier |
Required |
|
| WorkflowDefinitionCode | globally unique identifier |
None. |
|
| ThumbnailFileData | Collection of byte |
None. |
|
| ThumbnailPath | string |
None. |
|
| Fonts | Collection of FontDto |
None. |
|
| Filters | Collection of TemplatefilterCategoryDto |
None. |
|
| BudgetCodes | Collection of string |
None. |
|
| PreviewKey | string |
None. |
|
| Preview | PreviewDto |
None. |
|
| FolderId | globally unique identifier |
None. |
|
| LeadTime | integer |
None. |
|
| EnableTimeSelection | boolean |
None. |
|
| EnableScheduling | boolean |
None. |
|
| AllowableSchedulingDays | WeekDayDto |
None. |
|
| TemplateType | TemplateTypeDto |
None. |
|
| ViewPermissionGroupId | globally unique identifier |
None. |
|
| EditPermissionGroupId | globally unique identifier |
None. |
|
| DeletePermissionGroupId | globally unique identifier |
None. |
|
| CanEdit | boolean |
None. |
|
| CanDelete | boolean |
None. |
|
| EnableDescription | boolean |
None. |
|
| SchemaId | globally unique identifier |
None. |
|
| BusinessAreaId | globally unique identifier |
None. |
|
| RequiresApproval | boolean |
None. |
|
| ApprovalGroupId | globally unique identifier |
None. |
|
| DistributionPriceListId | globally unique identifier |
None. |
|
| LeadProductId | globally unique identifier |
None. |
|
| DataFileFolderId | globally unique identifier |
None. |
|
| RenderEngineId | globally unique identifier |
None. |
|
| TemplateProperties | Collection of TemplatePropertyDto |
None. |
|
| Ext_TemplateId | integer |
None. |
|
| Ext_ArtworkId | integer |
None. |
|
| Ext_ResourceId | integer |
None. |
|
| PR_Key | string |
None. |
|
| RB_ArtWorkToken | string |
None. |
|
| IsProgrammaticTemplate | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": "02e2bb48-a690-4ac5-a1ba-e2f529382b5b",
"TemplateCode": "3337ee5f-dc42-4cb8-842f-931ad66febd6",
"Name": "sample string 3",
"Description": "sample string 4",
"CreationDate": "2025-12-11T17:30:42.6480739Z",
"UserId": "513e1428-ee15-4de8-a472-36062fa58de5",
"TenantId": "f935f0c4-d786-4301-bf1a-a3fc4bf3663a",
"TenantName": "sample string 8",
"PublishDate": "2025-12-11T17:30:42.6480739Z",
"DeletedDate": "2025-12-11T17:30:42.6480739Z",
"Version": "sample string 9",
"WorkflowDefinitionId": "8a874c8d-5ac5-4d07-967a-14fce8555f20",
"WorkflowDefinitionCode": "ca5a1809-38cd-4125-bcc3-fd6d39cf13a1",
"ThumbnailFileData": "QEA=",
"ThumbnailPath": "sample string 12",
"Fonts": [
{
"Id": "33dfafb0-0384-4832-a4ef-8f4f2c578909",
"Name": "sample string 2",
"CreationDate": "2025-12-11T17:30:42.6480739Z"
},
{
"Id": "33dfafb0-0384-4832-a4ef-8f4f2c578909",
"Name": "sample string 2",
"CreationDate": "2025-12-11T17:30:42.6480739Z"
}
],
"Filters": [
{
"Id": "eded4666-c1cc-4df5-888e-64c9e18e28c6",
"TenantId": "0481ea8b-ebfb-4e97-be7c-0459b44da278",
"Name": "sample string 3",
"Values": [
"sample string 1",
"sample string 2"
]
},
{
"Id": "eded4666-c1cc-4df5-888e-64c9e18e28c6",
"TenantId": "0481ea8b-ebfb-4e97-be7c-0459b44da278",
"Name": "sample string 3",
"Values": [
"sample string 1",
"sample string 2"
]
}
],
"BudgetCodes": [
"sample string 1",
"sample string 2"
],
"PreviewKey": "sample string 13",
"Preview": {
"Key": "sample string 1",
"ProductPreviews": [
{
"ProductId": "d47c685f-5d4d-4041-a863-41a8f624d5bb",
"NumberOfPages": 2
},
{
"ProductId": "d47c685f-5d4d-4041-a863-41a8f624d5bb",
"NumberOfPages": 2
}
]
},
"FolderId": "622e7382-22a5-4931-8814-9dc5dd49a839",
"LeadTime": 1,
"EnableTimeSelection": true,
"EnableScheduling": true,
"AllowableSchedulingDays": 1,
"TemplateType": 1,
"ViewPermissionGroupId": "e562f648-fc85-4c8e-ad10-486e79e1e8a1",
"EditPermissionGroupId": "75406673-3e41-4180-a434-9eaf438778c1",
"DeletePermissionGroupId": "e32f95dc-29e7-4816-85f6-79adc836b742",
"CanEdit": true,
"CanDelete": true,
"EnableDescription": true,
"SchemaId": "e2798d29-c7ca-45b2-95d5-40c7238762a4",
"BusinessAreaId": "76d0900c-7a1c-4301-88a0-06677b7f0aa6",
"RequiresApproval": true,
"ApprovalGroupId": "47e1cfce-b670-4279-a0af-bffb5aae975b",
"DistributionPriceListId": "4ee5c422-54e0-4b77-8a04-7d8fefbc7c44",
"LeadProductId": "17de8c49-aa07-4999-8b81-7d66882fc545",
"DataFileFolderId": "24fd4f2f-a6b3-42bc-8941-f50ca58d2775",
"RenderEngineId": "9128232d-948a-4a60-9b85-d06c5b0efbd1",
"TemplateProperties": [
{
"Id": "b8f3b254-f983-4376-8734-7de754ae11a0",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2025-12-11T17:30:42.6480739Z",
"TemplateId": "2898877f-4d3f-4396-a4e3-fe42fc1b5c8a"
},
{
"Id": "b8f3b254-f983-4376-8734-7de754ae11a0",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2025-12-11T17:30:42.6480739Z",
"TemplateId": "2898877f-4d3f-4396-a4e3-fe42fc1b5c8a"
}
],
"Ext_TemplateId": 1,
"Ext_ArtworkId": 1,
"Ext_ResourceId": 1,
"PR_Key": "sample string 21",
"RB_ArtWorkToken": "sample string 22",
"IsProgrammaticTemplate": true
}
application/xml, text/xml
Sample:
<TemplateDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Template.Models">
<AllowableSchedulingDays>Sunday</AllowableSchedulingDays>
<ApprovalGroupId>47e1cfce-b670-4279-a0af-bffb5aae975b</ApprovalGroupId>
<BudgetCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</BudgetCodes>
<BusinessAreaId>76d0900c-7a1c-4301-88a0-06677b7f0aa6</BusinessAreaId>
<CanDelete>true</CanDelete>
<CanEdit>true</CanEdit>
<CreationDate>2025-12-11T17:30:42.6480739+00:00</CreationDate>
<DataFileFolderId>24fd4f2f-a6b3-42bc-8941-f50ca58d2775</DataFileFolderId>
<DeletePermissionGroupId>e32f95dc-29e7-4816-85f6-79adc836b742</DeletePermissionGroupId>
<DeletedDate>2025-12-11T17:30:42.6480739+00:00</DeletedDate>
<Description>sample string 4</Description>
<DistributionPriceListId>4ee5c422-54e0-4b77-8a04-7d8fefbc7c44</DistributionPriceListId>
<EditPermissionGroupId>75406673-3e41-4180-a434-9eaf438778c1</EditPermissionGroupId>
<EnableDescription>true</EnableDescription>
<EnableScheduling>true</EnableScheduling>
<EnableTimeSelection>true</EnableTimeSelection>
<Ext_ArtworkId>1</Ext_ArtworkId>
<Ext_ResourceId>1</Ext_ResourceId>
<Ext_TemplateId>1</Ext_TemplateId>
<Filters>
<TemplatefilterCategoryDto>
<Id>eded4666-c1cc-4df5-888e-64c9e18e28c6</Id>
<Name>sample string 3</Name>
<TenantId>0481ea8b-ebfb-4e97-be7c-0459b44da278</TenantId>
<Values xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</Values>
</TemplatefilterCategoryDto>
<TemplatefilterCategoryDto>
<Id>eded4666-c1cc-4df5-888e-64c9e18e28c6</Id>
<Name>sample string 3</Name>
<TenantId>0481ea8b-ebfb-4e97-be7c-0459b44da278</TenantId>
<Values xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</Values>
</TemplatefilterCategoryDto>
</Filters>
<FolderId>622e7382-22a5-4931-8814-9dc5dd49a839</FolderId>
<Fonts>
<FontDto>
<CreationDate>2025-12-11T17:30:42.6480739+00:00</CreationDate>
<Id>33dfafb0-0384-4832-a4ef-8f4f2c578909</Id>
<Name>sample string 2</Name>
</FontDto>
<FontDto>
<CreationDate>2025-12-11T17:30:42.6480739+00:00</CreationDate>
<Id>33dfafb0-0384-4832-a4ef-8f4f2c578909</Id>
<Name>sample string 2</Name>
</FontDto>
</Fonts>
<Id>02e2bb48-a690-4ac5-a1ba-e2f529382b5b</Id>
<IsProgrammaticTemplate>true</IsProgrammaticTemplate>
<LeadProductId>17de8c49-aa07-4999-8b81-7d66882fc545</LeadProductId>
<LeadTime>1</LeadTime>
<Name>sample string 3</Name>
<PR_Key>sample string 21</PR_Key>
<Preview>
<Key>sample string 1</Key>
<ProductPreviews>
<ProductPreviewDto>
<NumberOfPages>2</NumberOfPages>
<ProductId>d47c685f-5d4d-4041-a863-41a8f624d5bb</ProductId>
</ProductPreviewDto>
<ProductPreviewDto>
<NumberOfPages>2</NumberOfPages>
<ProductId>d47c685f-5d4d-4041-a863-41a8f624d5bb</ProductId>
</ProductPreviewDto>
</ProductPreviews>
</Preview>
<PreviewKey>sample string 13</PreviewKey>
<PublishDate>2025-12-11T17:30:42.6480739+00:00</PublishDate>
<RB_ArtWorkToken>sample string 22</RB_ArtWorkToken>
<RenderEngineId>9128232d-948a-4a60-9b85-d06c5b0efbd1</RenderEngineId>
<RequiresApproval>true</RequiresApproval>
<SchemaId>e2798d29-c7ca-45b2-95d5-40c7238762a4</SchemaId>
<TemplateCode>3337ee5f-dc42-4cb8-842f-931ad66febd6</TemplateCode>
<TemplateProperties>
<TemplatePropertyDto>
<CreationDate>2025-12-11T17:30:42.6480739+00:00</CreationDate>
<Id>b8f3b254-f983-4376-8734-7de754ae11a0</Id>
<Name>sample string 2</Name>
<TemplateId>2898877f-4d3f-4396-a4e3-fe42fc1b5c8a</TemplateId>
<Value>sample string 3</Value>
</TemplatePropertyDto>
<TemplatePropertyDto>
<CreationDate>2025-12-11T17:30:42.6480739+00:00</CreationDate>
<Id>b8f3b254-f983-4376-8734-7de754ae11a0</Id>
<Name>sample string 2</Name>
<TemplateId>2898877f-4d3f-4396-a4e3-fe42fc1b5c8a</TemplateId>
<Value>sample string 3</Value>
</TemplatePropertyDto>
</TemplateProperties>
<TemplateType>DirectMail</TemplateType>
<TenantId>f935f0c4-d786-4301-bf1a-a3fc4bf3663a</TenantId>
<TenantName>sample string 8</TenantName>
<ThumbnailFileData>QEA=</ThumbnailFileData>
<ThumbnailPath>sample string 12</ThumbnailPath>
<UserId>513e1428-ee15-4de8-a472-36062fa58de5</UserId>
<Version>sample string 9</Version>
<ViewPermissionGroupId>e562f648-fc85-4c8e-ad10-486e79e1e8a1</ViewPermissionGroupId>
<WorkflowDefinitionCode>ca5a1809-38cd-4125-bcc3-fd6d39cf13a1</WorkflowDefinitionCode>
<WorkflowDefinitionId>8a874c8d-5ac5-4d07-967a-14fce8555f20</WorkflowDefinitionId>
</TemplateDto>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
None.