POST api/documentgeneration/renamelettertemplate/{id}
Rename a letter template and change the description
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Document Id for the template |
integer |
Required |
Body Parameters
The letter template.
TemplateRenameDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Filename | string |
None. |
|
| Description | string |
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"
}
Response Information
Resource Description
LetterTemplateDataContract| Name | Description | 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:
Sample not available.
text/json
Sample:
Sample not available.