POST api/documentgeneration/saveenvelopetemplatepack

Saves or updates envelope template correspondence for a 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 pack save data contract supplied with the request.

EnvelopeTemplatePackSaveDataContract
NameDescriptionTypeAdditional information
FriendlyName

The friendly name value.

string

None.

EnvelopeTemplatePackType

The envelope template pack type value.

EnumDataContract

None.

EnvelopeTemplates

The collection of envelope templates.

Collection of integer

None.

IsDefault

Indicates whether this item is default.

boolean

None.

NotReady

Indicates whether not ready is true.

boolean

None.

CustomPrompt

The custom prompt value.

string

None.

Description

The description value.

string

None.

WorkflowIndex

The workflow index value.

integer

None.

Hidden

Indicates whether hidden is true.

boolean

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",
  "EnvelopeTemplatePackType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "EnvelopeTemplates": [
    1,
    2
  ],
  "IsDefault": true,
  "NotReady": true,
  "CustomPrompt": "sample string 4",
  "Description": "sample string 5",
  "WorkflowIndex": 6,
  "Hidden": true,
  "Id": 8
}

Response Information

Resource Description

The response returned after the operation completes.

PostTemplateDataContract
NameDescriptionTypeAdditional 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
}