POST api/documentgeneration/saveenvelopetemplate

Saves or updates the envelope template for an agency Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The envelope template save data contract supplied with the request.

EnvelopeTemplateSaveDataContract

Name	Description	Type	Additional information
FriendlyName	The friendly name value.	string	None.
LetterTemplates	The collection of letter templates.	Collection of integer	None.
CanBeSplit	Indicates whether this item can be split.	boolean	None.
EnvelopeTemplateTargetType	The envelope template target type value.	EnumDataContract	None.
Description	The description value.	string	None.
PreventDigitalSignature	Indicates whether prevent digital signature is true.	boolean	None.
EnvelopeCCdNegotiators	The envelope c cd negotiators value.	integer	None.
Id	The unique identifier of this resource.	integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "FriendlyName": "sample string 1",
  "LetterTemplates": [
    1,
    2
  ],
  "CanBeSplit": true,
  "EnvelopeTemplateTargetType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Description": "sample string 3",
  "PreventDigitalSignature": true,
  "EnvelopeCCdNegotiators": 5,
  "Id": 6
}

Response Information

Resource Description

The response returned after the operation completes.

PostTemplateDataContract

Name	Description	Type	Additional information
Contract	The contract value.	BaseDataContract	None.
Warnings	The collection of warnings.	Collection of string	None.
Id	The unique identifier of this resource.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Contract": {
    "Id": 1
  },
  "Warnings": [
    "sample string 1",
    "sample string 2"
  ],
  "Id": 1
}