POST api/Templates

Creates a template.

Request Information

URI Parameters

None.

Body Parameters

The template model to create with.

Name	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": "c6c0e9ee-b24e-4664-8b10-71995a8deae8",
  "TemplateCode": "936cd545-e75c-4214-a19f-ccab2c6043e0",
  "Name": "sample string 3",
  "Description": "sample string 4",
  "CreationDate": "2026-01-11T17:47:52.9129937Z",
  "UserId": "8105c2a7-6ee9-4607-8ba1-a74f4b381077",
  "TenantId": "244ebb6c-4c8b-43e5-ac6a-72f7fb80f047",
  "TenantName": "sample string 8",
  "PublishDate": "2026-01-11T17:47:52.9129937Z",
  "DeletedDate": "2026-01-11T17:47:52.9129937Z",
  "Version": "sample string 9",
  "WorkflowDefinitionId": "0cfd80b2-85ae-4d64-8150-e2862d71c1ff",
  "WorkflowDefinitionCode": "6e67cc68-d734-4ddd-90aa-166ddca32818",
  "ThumbnailFileData": "QEA=",
  "ThumbnailPath": "sample string 12",
  "Fonts": [
    {
      "Id": "d9b87ec3-9ced-41bb-8772-1a8016c98a27",
      "Name": "sample string 2",
      "CreationDate": "2026-01-11T17:47:52.9129937Z"
    },
    {
      "Id": "d9b87ec3-9ced-41bb-8772-1a8016c98a27",
      "Name": "sample string 2",
      "CreationDate": "2026-01-11T17:47:52.9129937Z"
    }
  ],
  "Filters": [
    {
      "Id": "31b3891b-d5ca-47a2-92cc-38c62587758f",
      "TenantId": "4254a2e1-4cd3-4734-813f-c7e5b73b0076",
      "Name": "sample string 3",
      "Values": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "Id": "31b3891b-d5ca-47a2-92cc-38c62587758f",
      "TenantId": "4254a2e1-4cd3-4734-813f-c7e5b73b0076",
      "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": "008cdb1d-c003-4ec3-9491-14ce1b218113",
        "NumberOfPages": 2
      },
      {
        "ProductId": "008cdb1d-c003-4ec3-9491-14ce1b218113",
        "NumberOfPages": 2
      }
    ]
  },
  "FolderId": "2e425916-1a85-4bec-99a1-dd4a6f3367b3",
  "LeadTime": 1,
  "EnableTimeSelection": true,
  "EnableScheduling": true,
  "AllowableSchedulingDays": 1,
  "TemplateType": 1,
  "ViewPermissionGroupId": "b1490883-85cf-4c21-a94e-08eb2c5c732d",
  "EditPermissionGroupId": "ea30c772-4a57-424e-b67f-cf981bf04001",
  "DeletePermissionGroupId": "ee4e9e19-1822-4e5e-8ca9-4e486d6b57dd",
  "CanEdit": true,
  "CanDelete": true,
  "EnableDescription": true,
  "SchemaId": "fc8bb95d-cf8f-482c-91c2-3fdc49d66fd4",
  "BusinessAreaId": "7c1d98a8-c4b1-4eb1-8ded-80508aa74d7f",
  "RequiresApproval": true,
  "ApprovalGroupId": "36da4fb0-c783-4430-81b9-08fad563fabe",
  "DistributionPriceListId": "690ab4f0-991b-4115-8460-583736c9e70a",
  "LeadProductId": "a0cd31ab-6e8e-486c-8a23-a194d07efe9e",
  "DataFileFolderId": "8e3dccc6-fca3-417a-9d01-8ef18f219956",
  "RenderEngineId": "46ff1316-89ef-404b-bf77-98a81e1ddc31",
  "TemplateProperties": [
    {
      "Id": "741e34e7-bbc1-41af-bde0-36df1af181dd",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "CreationDate": "2026-01-11T17:47:52.9286756Z",
      "TemplateId": "4f07a7ea-83b0-40db-afa6-ba8ce996fc5b"
    },
    {
      "Id": "741e34e7-bbc1-41af-bde0-36df1af181dd",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "CreationDate": "2026-01-11T17:47:52.9286756Z",
      "TemplateId": "4f07a7ea-83b0-40db-afa6-ba8ce996fc5b"
    }
  ],
  "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>36da4fb0-c783-4430-81b9-08fad563fabe</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>7c1d98a8-c4b1-4eb1-8ded-80508aa74d7f</BusinessAreaId>
  <CanDelete>true</CanDelete>
  <CanEdit>true</CanEdit>
  <CreationDate>2026-01-11T17:47:52.9129937+00:00</CreationDate>
  <DataFileFolderId>8e3dccc6-fca3-417a-9d01-8ef18f219956</DataFileFolderId>
  <DeletePermissionGroupId>ee4e9e19-1822-4e5e-8ca9-4e486d6b57dd</DeletePermissionGroupId>
  <DeletedDate>2026-01-11T17:47:52.9129937+00:00</DeletedDate>
  <Description>sample string 4</Description>
  <DistributionPriceListId>690ab4f0-991b-4115-8460-583736c9e70a</DistributionPriceListId>
  <EditPermissionGroupId>ea30c772-4a57-424e-b67f-cf981bf04001</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>31b3891b-d5ca-47a2-92cc-38c62587758f</Id>
      <Name>sample string 3</Name>
      <TenantId>4254a2e1-4cd3-4734-813f-c7e5b73b0076</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>31b3891b-d5ca-47a2-92cc-38c62587758f</Id>
      <Name>sample string 3</Name>
      <TenantId>4254a2e1-4cd3-4734-813f-c7e5b73b0076</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>2e425916-1a85-4bec-99a1-dd4a6f3367b3</FolderId>
  <Fonts>
    <FontDto>
      <CreationDate>2026-01-11T17:47:52.9129937+00:00</CreationDate>
      <Id>d9b87ec3-9ced-41bb-8772-1a8016c98a27</Id>
      <Name>sample string 2</Name>
    </FontDto>
    <FontDto>
      <CreationDate>2026-01-11T17:47:52.9129937+00:00</CreationDate>
      <Id>d9b87ec3-9ced-41bb-8772-1a8016c98a27</Id>
      <Name>sample string 2</Name>
    </FontDto>
  </Fonts>
  <Id>c6c0e9ee-b24e-4664-8b10-71995a8deae8</Id>
  <IsProgrammaticTemplate>true</IsProgrammaticTemplate>
  <LeadProductId>a0cd31ab-6e8e-486c-8a23-a194d07efe9e</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>008cdb1d-c003-4ec3-9491-14ce1b218113</ProductId>
      </ProductPreviewDto>
      <ProductPreviewDto>
        <NumberOfPages>2</NumberOfPages>
        <ProductId>008cdb1d-c003-4ec3-9491-14ce1b218113</ProductId>
      </ProductPreviewDto>
    </ProductPreviews>
  </Preview>
  <PreviewKey>sample string 13</PreviewKey>
  <PublishDate>2026-01-11T17:47:52.9129937+00:00</PublishDate>
  <RB_ArtWorkToken>sample string 22</RB_ArtWorkToken>
  <RenderEngineId>46ff1316-89ef-404b-bf77-98a81e1ddc31</RenderEngineId>
  <RequiresApproval>true</RequiresApproval>
  <SchemaId>fc8bb95d-cf8f-482c-91c2-3fdc49d66fd4</SchemaId>
  <TemplateCode>936cd545-e75c-4214-a19f-ccab2c6043e0</TemplateCode>
  <TemplateProperties>
    <TemplatePropertyDto>
      <CreationDate>2026-01-11T17:47:52.9286756+00:00</CreationDate>
      <Id>741e34e7-bbc1-41af-bde0-36df1af181dd</Id>
      <Name>sample string 2</Name>
      <TemplateId>4f07a7ea-83b0-40db-afa6-ba8ce996fc5b</TemplateId>
      <Value>sample string 3</Value>
    </TemplatePropertyDto>
    <TemplatePropertyDto>
      <CreationDate>2026-01-11T17:47:52.9286756+00:00</CreationDate>
      <Id>741e34e7-bbc1-41af-bde0-36df1af181dd</Id>
      <Name>sample string 2</Name>
      <TemplateId>4f07a7ea-83b0-40db-afa6-ba8ce996fc5b</TemplateId>
      <Value>sample string 3</Value>
    </TemplatePropertyDto>
  </TemplateProperties>
  <TemplateType>DirectMail</TemplateType>
  <TenantId>244ebb6c-4c8b-43e5-ac6a-72f7fb80f047</TenantId>
  <TenantName>sample string 8</TenantName>
  <ThumbnailFileData>QEA=</ThumbnailFileData>
  <ThumbnailPath>sample string 12</ThumbnailPath>
  <UserId>8105c2a7-6ee9-4607-8ba1-a74f4b381077</UserId>
  <Version>sample string 9</Version>
  <ViewPermissionGroupId>b1490883-85cf-4c21-a94e-08eb2c5c732d</ViewPermissionGroupId>
  <WorkflowDefinitionCode>6e67cc68-d734-4ddd-90aa-166ddca32818</WorkflowDefinitionCode>
  <WorkflowDefinitionId>0cfd80b2-85ae-4d64-8150-e2862d71c1ff</WorkflowDefinitionId>
</TemplateDto>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'TemplateDto'.

Response Information

Resource Description

None.