POST api/documentgeneration/updatelettertemplate/{id}
Updates a merge letter template
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
Document Id for the template |
integer |
Required |
Body Parameters
The letter template.
Dezrez.Core.DataContracts.External.Api.DocumentGeneration.Commands.LetterTemplateSaveDataContractRequest Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
multipart/form-data
Sample:
Sample not available.
application/json, text/json
Sample:
{ "TemplateType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "OutputFormat": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "TemplateOutputDocumentSubType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "RequiredTypes": [ { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" } ], "AnalyticsCampaign": { "Name": "sample string 1", "Id": 2 }, "ApplyStyleDocument": true, "ReadOnlyInPreview": true, "XsltRepresentation": "sample string 3", "IsPublic": true, "ExpiryDate": "2024-10-06T00:08:22.0424047Z", "StartDate": "2024-10-06T00:08:22.0424047Z", "DocumentPlaceholderType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "DocumentPlaceholderSourceType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FileStream": null, "Tags": [ { "Name": "sample string 1", "SystemStatusName": "sample string 2", "TagType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 3 }, { "Name": "sample string 1", "SystemStatusName": "sample string 2", "TagType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 3 } ], "DocumentType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "DocumentSubType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FileName": "sample string 5", "ContentType": "sample string 6", "FileExtension": "sample string 7", "Description": "sample string 8", "FileSize": "sample string 9", "CreatedDate": "2024-10-06T00:08:22.0424047Z", "CreatedBy": { "Initials": "sample string 1", "ContactName": "sample string 2", "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 3", "FirstName": "sample string 4", "LastName": "sample string 5", "PrimaryTelephone": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "PrimaryEmail": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "JobTitle": "sample string 6", "Id": 7 }, "Id": 11 }
Response Information
Resource Description
Dezrez.Core.DataContracts.External.Api.DocumentGeneration.Query.LetterTemplateDataContractName | Description | Type | Additional information |
---|---|---|---|
TemplateType | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
OutputFormat | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
TemplateOutputDocumentSubType | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
RequiredTypes | Collection of Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
AnalyticsCampaign | Dezrez.Core.DataContracts.External.Api.Agency.Query.Analytics.CampaignDataContract |
None. |
|
ApplyStyleDocument | boolean |
None. |
|
ReadOnlyInPreview | boolean |
None. |
|
CreatedById | integer |
None. |
|
Url | string |
None. |
|
RequiresAuthentication | boolean |
None. |
|
ExpiryDate | date |
None. |
|
FileStream | System.IO.Stream |
None. |
|
Tags | Collection of Dezrez.Core.DataContracts.External.Api.System.TagDataContract |
None. |
|
DocumentType | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
DocumentSubType | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
FileName | string |
None. |
|
ContentType | string |
None. |
|
FileExtension | string |
None. |
|
Description | string |
None. |
|
FileSize | string |
None. |
|
CreatedDate | date |
None. |
|
CreatedBy | Dezrez.Core.DataContracts.External.Api.People.Query.Get.CreatedByDataContract |
None. |
|
Id | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "TemplateType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "OutputFormat": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "TemplateOutputDocumentSubType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "RequiredTypes": [ { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" } ], "AnalyticsCampaign": { "Name": "sample string 1", "CreatedDate": "2024-10-06T00:08:22.0580358Z", "CreatedBy": { "Initials": "sample string 1", "ContactName": "sample string 2", "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 3", "FirstName": "sample string 4", "LastName": "sample string 5", "PrimaryTelephone": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "PrimaryEmail": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "JobTitle": "sample string 6", "Id": 7 }, "Id": 3 }, "ApplyStyleDocument": true, "ReadOnlyInPreview": true, "CreatedById": 3, "Url": "sample string 4", "RequiresAuthentication": true, "ExpiryDate": "2024-10-06T00:08:22.0580358Z", "FileStream": null, "Tags": [ { "Name": "sample string 1", "SystemStatusName": "sample string 2", "TagType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 3 }, { "Name": "sample string 1", "SystemStatusName": "sample string 2", "TagType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 3 } ], "DocumentType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "DocumentSubType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FileName": "sample string 6", "ContentType": "sample string 7", "FileExtension": "sample string 8", "Description": "sample string 9", "FileSize": "sample string 10", "CreatedDate": "2024-10-06T00:08:22.0580358Z", "CreatedBy": { "Initials": "sample string 1", "ContactName": "sample string 2", "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 3", "FirstName": "sample string 4", "LastName": "sample string 5", "PrimaryTelephone": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "PrimaryEmail": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "JobTitle": "sample string 6", "Id": 7 }, "Id": 12 }