POST api/documentgeneration/saveenvelopetemplate

Saves or updates the envelope template for an agency

Request Information

URI Parameters

None.

Body Parameters

EnvelopeTemplateSaveDataContract
NameDescriptionTypeAdditional information
FriendlyName

string

None.

LetterTemplates

Collection of integer

None.

CanBeSplit

boolean

None.

EnvelopeTemplateTargetType

EnumDataContract

None.

Description

string

None.

PreventDigitalSignature

boolean

None.

EnvelopeCCdNegotiators

integer

None.

Id

integer

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'EnvelopeTemplateSaveDataContract'.

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

PostTemplateDataContract
NameDescriptionTypeAdditional information
Contract

BaseDataContract

None.

Warnings

Collection of string

None.

Id

integer

None.

Response Formats

application/json, text/json

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