POST api/documentgeneration/lettertemplate/properties/{id}

Update the properties of a template, but not its content.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Document Id for the template	integer	Required

Body Parameters

The letter template property changes.

TemplatePropertiesSaveDataContract

Name	Type	Additional information
Filename	string	None.
Description	string	None.
AnalyticsCampaign	integer	None.
ApplyStyleDocument	boolean	None.
ReadOnlyInPreview	boolean	None.
TemplateOutputDocumentSubType	EnumDataContract	None.

Request Formats

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 'TemplatePropertiesSaveDataContract'.

application/json, text/json

Sample:

{
  "Filename": "sample string 1",
  "Description": "sample string 2",
  "AnalyticsCampaign": 3,
  "ApplyStyleDocument": true,
  "ReadOnlyInPreview": true,
  "TemplateOutputDocumentSubType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  }
}

Response Information

Resource Description

LetterTemplateDataContract

Name	Type	Additional information
TemplateType	EnumDataContract	None.
OutputFormat	EnumDataContract	None.
TemplateOutputDocumentSubType	EnumDataContract	None.
RequiredTypes	Collection of EnumDataContract	None.
AnalyticsCampaign	CampaignDataContract	None.
ApplyStyleDocument	boolean	None.
ReadOnlyInPreview	boolean	None.
CreatedById	integer	None.
Url	string	None.
RequiresAuthentication	boolean	None.
ExpiryDate	date	None.
Attachments	Collection of DocumentDataContract	None.
ProcessedSuccessfully	boolean	None.
ErrorMessage	string	None.
FileStream	Stream	None.
Tags	Collection of TagDataContract	None.
ApprovalStatus	DocumentApprovalDataContract	None.
DocumentType	EnumDataContract	None.
DocumentSubType	EnumDataContract	None.
FileName	string	None.
ContentType	string	None.
FileExtension	string	None.
Description	string	None.
FileSize	string	None.
CreatedDate	date	None.
CreatedBy	CreatedByDataContract	None.
Id	integer	None.

Response Formats

application/json

Sample:

An exception has occurred while using the formatter 'SanitizingJsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'Dezrez.Core.DataContracts.External.Api.Media.DocumentDataContract'. Path 'Attachments[0].Attachments'.

text/json

Sample:

An exception has occurred while using the formatter 'SanitizingJsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'Dezrez.Core.DataContracts.External.Api.Media.DocumentDataContract'. Path 'Attachments[0].Attachments'.