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

Update the properties of a template, but not its content. Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

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	Description	Type	Additional information
Filename	The filename value.	string	None.
Description	The description value.	string	None.
AnalyticsCampaign	The analytics campaign value.	integer	None.
ApplyStyleDocument	Indicates whether apply style document is true.	boolean	None.
ReadOnlyInPreview	Indicates whether read only in preview is true.	boolean	None.
TemplateOutputDocumentSubType	The template output document sub type value.	EnumDataContract	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

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

The response returned after the operation completes.

LetterTemplateDataContract

Name	Description	Type	Additional information
TemplateType	The template type value.	EnumDataContract	None.
OutputFormat	The output format value.	EnumDataContract	None.
TemplateOutputDocumentSubType	The template output document sub type value.	EnumDataContract	None.
RequiredTypes	The collection of required types.	Collection of EnumDataContract	None.
AnalyticsCampaign	The analytics campaign value.	CampaignDataContract	None.
ApplyStyleDocument	Indicates whether apply style document is true.	boolean	None.
ReadOnlyInPreview	Indicates whether read only in preview is true.	boolean	None.
CreatedById	The unique identifier of the related created by resource.	integer	None.
Url	The url value.	string	None.
RequiresAuthentication	Indicates whether requires authentication is true.	boolean	None.
ExpiryDate	The expiry date, expressed as a date and time.	date	None.
Attachments	The collection of attachments.	Collection of DocumentDataContract	None.
ProcessedSuccessfully	Indicates whether processed successfully is true.	boolean	None.
ErrorMessage	The error message value.	string	None.
IsGenerated	Indicates whether this item is generated.	boolean	None.
Roles	The collection of roles.	Collection of DocumentRoleDataContract	None.
Properties	The collection of properties.	Collection of DocumentPropertyDataContract	None.
Groups	The collection of groups.	Collection of DocumentGroupDataContract	None.
FileStream	The file stream value.	Stream	None.
Tags	The collection of tags.	Collection of TagDataContract	None.
ApprovalStatus	The approval status value.	DocumentApprovalDataContract	None.
DocumentType	The document type value.	EnumDataContract	None.
DocumentSubType	The document sub type value.	EnumDataContract	None.
FileName	The file name value.	string	None.
ContentType	The content type value.	string	None.
FileExtension	The file extension value.	string	None.
Description	The description value.	string	None.
FileSize	The file size value.	string	None.
CreatedDate	The created date, expressed as a date and time.	date	None.
CreatedBy	The created by value.	CreatedByDataContract	None.
Id	The unique identifier of this resource.	integer	None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.