PUT api/v2/documents/templates/edit

EditDocumentTemplate

Request Information

URI Parameters

None.

Body Parameters

The command

Name	Type	Additional information
DocumentTemplateId	universally unique identifier	Required
Name	string	Required Max length: 100
Description	string	Required Max length: 500
GroupName	string	Max length: 100
Order	integer (32 bits)	Required
IsDefault	boolean	Required
IsPublic	boolean	Required
Enabled	boolean	Required
Pdf	EditDocumentTemplateCommandPdf	None.
Tailwind	EditDocumentTemplateCommandTailwind	None.
Settings	Collection of EditDocumentTemplateCommandSetting	None.

Request Formats

application/json

Sample:

{
  "DocumentTemplateId": "00000000-0000-0000-0000-000000000000",
  "Name": "sample string 1",
  "Description": "sample string 2",
  "GroupName": "sample string 3",
  "Order": 1,
  "IsDefault": true,
  "IsPublic": true,
  "Enabled": true,
  "Pdf": {
    "PageSize": "Letter",
    "Orientation": "Landscape",
    "MarginLeft": 1.1,
    "MarginRight": 1.1,
    "MarginTop": 1.1,
    "MarginBottom": 1.1,
    "EnableJavaScript": true,
    "Javascript": "sample string 1",
    "FirstPageNumber": 1,
    "PrintHtmlBackgrounds": true,
    "UseMarginsOnHeaderAndFooter": [
      "None",
      "None"
    ],
    "Title": "sample string 2",
    "Zoom": 1,
    "EnableMathematicalLaTex": true,
    "GrayScale": true,
    "CssMediaType": "Print",
    "CustomCssUrl": "sample string 3",
    "CreatePdfFormsFromHtml": true,
    "TableOfContentsTypes": "None",
    "ForcePaperSize": true,
    "FitToPaperModes": "Zoom",
    "HeaderLoadStylesAndCSSFromMainHtmlDocument": true,
    "HeaderUseCssFromMainDocument": true,
    "HeaderMaxHeight": 1,
    "FooterLoadStylesAndCSSFromMainHtmlDocument": true,
    "FooterUseCssFromMainDocument": true,
    "FooterMaxHeight": 1
  },
  "Tailwind": {
    "GradientPrimary": "sample string 1",
    "GradientSecondary": "sample string 2",
    "BackgroundPrimary": "sample string 3",
    "BackgroundSecondary": "sample string 4",
    "BackgroundTertiary": "sample string 5",
    "BackgroundQuaternary": "sample string 6",
    "BackgroundPopover": "sample string 7",
    "BackgroundTab": "sample string 8",
    "InputBorder": "sample string 9",
    "InputBorderShadow": "sample string 10",
    "TextPrimary": "sample string 11",
    "TextSecondary": "sample string 12",
    "TextTertiary": "sample string 13",
    "TextQuaternary": "sample string 14",
    "IconPrimary": "sample string 15",
    "IconSecondary": "sample string 16",
    "BrandPrimary": "sample string 17",
    "BrandSecondary": "sample string 18",
    "Link": "sample string 19",
    "Radius": "sample string 20",
    "FontSizeH1": "sample string 21",
    "FontSizeH2": "sample string 22",
    "FontSizeH3": "sample string 23",
    "FontSizeH4": "sample string 24",
    "FontSizeH5": "sample string 25",
    "FontSizeH6": "sample string 26",
    "FontSizeP": "sample string 27",
    "FontSizeLi": "sample string 28",
    "FontSizeTd": "sample string 29",
    "FontFamily": "sample string 30",
    "LineHeightH1": "sample string 31",
    "LineHeightH2": "sample string 32",
    "LineHeightH3": "sample string 33",
    "LineHeightH4": "sample string 34",
    "LineHeightH5": "sample string 35",
    "LineHeightH6": "sample string 36",
    "LineHeightP": "sample string 37",
    "LineHeightLi": "sample string 38",
    "LineHeightTd": "sample string 39",
    "FontWeightH1": "sample string 40",
    "FontWeightH2": "sample string 41",
    "FontWeightH3": "sample string 42",
    "FontWeightH4": "sample string 43",
    "FontWeightH5": "sample string 44",
    "FontWeightH6": "sample string 45",
    "FontWeightP": "sample string 46",
    "FontWeightLi": "sample string 47",
    "FontWeightTd": "sample string 48",
    "IndentLength": "sample string 49"
  },
  "Settings": [
    {
      "DocumentTemplateSettingId": "00000000-0000-0000-0000-000000000000",
      "Enabled": true,
      "ImageQuality": "Original",
      "Toggle": true,
      "WholeNumber": 1,
      "DecimalNumber": 1.0,
      "Date": "2025-04-16T16:42:31.506",
      "DateTime": "2025-04-16T16:42:31.506",
      "DateTimeOffset": "2025-04-16T15:42:31.506+00:00",
      "Text": "sample string 1"
    },
    {
      "DocumentTemplateSettingId": "00000000-0000-0000-0000-000000000000",
      "Enabled": true,
      "ImageQuality": "Original",
      "Toggle": true,
      "WholeNumber": 1,
      "DecimalNumber": 1.0,
      "Date": "2025-04-16T16:42:31.506",
      "DateTime": "2025-04-16T16:42:31.506",
      "DateTimeOffset": "2025-04-16T15:42:31.506+00:00",
      "Text": "sample string 1"
    }
  ]
}

Response Information

Resource Description

EditDocumentTemplateCommandResult

Name	Description	Type	Additional information
Result		EditDocumentTemplateCommandResultKind	Required

Response Formats

application/json

Sample:

{
  "Result": "Success"
}