POST api/documentgeneration/createheadertemplate/{brandId}

Uploads a new header template

Request Information

URI Parameters

Name	Description	Type	Additional information
brandId	Brand Id for this header	integer	Required

Body Parameters

The letter template.

LetterTemplateSaveDataContract

Name	Type	Additional information
TemplateType	EnumDataContract	None.
OutputFormat	EnumDataContract	None.
TemplateOutputDocumentSubType	EnumDataContract	None.
RequiredTypes	Collection of EnumDataContract	None.
AnalyticsCampaign	CampaignSaveDataContract	None.
ApplyStyleDocument	boolean	None.
ReadOnlyInPreview	boolean	None.
XsltRepresentation	string	None.
IsPublic	boolean	None.
NeedsApproval	boolean	None.
ExpiryDate	date	None.
StartDate	date	None.
DocumentPlaceholderType	EnumDataContract	None.
DocumentPlaceholderSourceType	EnumDataContract	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.

Request 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,
  "NeedsApproval": true,
  "ExpiryDate": "2025-11-18T14:09:16.1946047Z",
  "StartDate": "2025-11-18T14:09:16.1946047Z",
  "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
    }
  ],
  "ApprovalStatus": {
    "Status": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Reason": "sample string 1",
    "LastUpdatedBy": {
      "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
    },
    "CreatedDate": "2025-11-18T14:09:16.1946047Z",
    "LastUpdated": "2025-11-18T14:09:16.1946047Z",
    "Id": 4
  },
  "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": "2025-11-18T14:09:16.1946047Z",
  "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
}

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:

Sample not available.

text/json

Sample:

Sample not available.