POST api/documentgeneration/updatetextsackcontent/{sackReference}

updates the content of a sack

Request Information

URI Parameters

NameDescriptionTypeAdditional information
sackReference

string

Required

Body Parameters

Dezrez.Core.DataContracts.External.Api.DocumentGeneration.Query.EnvelopeTextDataContract
NameDescriptionTypeAdditional information
ToContactItemIds

Collection of integer

None.

envelopeTemplateId

integer

None.

SackReference

string

None.

Reference

string

None.

FriendlyName

string

None.

Letters

Collection of Dezrez.Core.DataContracts.External.Api.DocumentGeneration.Query.LetterDataContract

None.

PropertyRoleIds

Collection of integer

None.

GroupRoleIds

Collection of integer

None.

OwnsRoleId

integer

None.

ParentGroupId

integer

None.

PersonId

integer

None.

ContainsPrintable

boolean

None.

IsEmailCompatible

boolean

None.

IsTextCompatible

boolean

None.

IsBymCompatible

boolean

None.

PersonName

string

None.

OutputPdf

boolean

None.

Created

date

None.

Expires

date

None.

CreatedByWorkflow

boolean

None.

GeneratedDocs

Collection of integer

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "ToContactItemIds": [
    1,
    2
  ],
  "envelopeTemplateId": 1,
  "SackReference": "sample string 2",
  "Reference": "sample string 3",
  "FriendlyName": "sample string 4",
  "Letters": [
    {
      "Partition": 1,
      "Reference": "sample string 2",
      "Filename": "sample string 3",
      "FileExtension": "sample string 4",
      "TemplateType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "TemplateOutputDocumentSubType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "ContentType": "sample string 5",
      "PostDocGenerationHandler": {
        "EntityType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "EntityId": 1,
        "JobHandlerType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Options": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        },
        "DocumentSubType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "AccountingSystemId": 2,
        "AgencyId": 3
      },
      "LetterTemplateId": 6,
      "EnvelopeTemplatePackId": 7
    },
    {
      "Partition": 1,
      "Reference": "sample string 2",
      "Filename": "sample string 3",
      "FileExtension": "sample string 4",
      "TemplateType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "TemplateOutputDocumentSubType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "ContentType": "sample string 5",
      "PostDocGenerationHandler": {
        "EntityType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "EntityId": 1,
        "JobHandlerType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Options": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        },
        "DocumentSubType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "AccountingSystemId": 2,
        "AgencyId": 3
      },
      "LetterTemplateId": 6,
      "EnvelopeTemplatePackId": 7
    }
  ],
  "PropertyRoleIds": [
    1,
    2
  ],
  "GroupRoleIds": [
    1,
    2
  ],
  "OwnsRoleId": 5,
  "ParentGroupId": 1,
  "PersonId": 1,
  "ContainsPrintable": true,
  "IsEmailCompatible": true,
  "IsTextCompatible": true,
  "IsBymCompatible": true,
  "PersonName": "sample string 10",
  "OutputPdf": true,
  "Created": "2024-10-15T18:02:15.1844906Z",
  "Expires": "2024-10-15T18:02:15.1844906Z",
  "CreatedByWorkflow": true,
  "GeneratedDocs": [
    1,
    2
  ]
}

Response Information

Resource Description

System.Net.Http.HttpResponseMessage
NameDescriptionTypeAdditional information
Version

System.Version

None.

Content

System.Net.Http.HttpContent

None.

StatusCode

System.Net.HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

System.Net.Http.HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.