Skip to content
Legaldoc.ioLegaldoc.ioLegaldoc.io

Update envelope

POST
/envelope/update
curl --request POST \
  --url https://app.legaldoc.com/api/v2/envelope/update \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "envelopeId": "example", "data": { "title": "example", "externalId": "example", "visibility": "EVERYONE", "globalAccessAuth": [ "ACCOUNT" ], "globalActionAuth": [ "ACCOUNT" ], "folderId": "example", "templateType": "PUBLIC" }, "meta": { "subject": "example", "message": "example", "timezone": "example", "dateFormat": "yyyy-MM-dd hh:mm a", "distributionMethod": "EMAIL", "signingOrder": "PARALLEL", "allowDictateNextSigner": true, "redirectUrl": "example", "language": "de", "typedSignatureEnabled": true, "uploadSignatureEnabled": true, "drawSignatureEnabled": true, "emailId": "example", "emailReplyTo": "example", "emailSettings": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true }, "envelopeExpirationPeriod": { "unit": "day", "amount": 1 }, "reminderSettings": { "sendAfter": { "unit": "day", "amount": 1 }, "repeatEvery": { "unit": "day", "amount": 1 } } } }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
envelopeId
required
string
data
object
title
string
>= 1 characters <= 255 characters
externalId
string | null
<= 255 characters
visibility
string
Allowed values: EVERYONE MANAGER_AND_ABOVE ADMIN
globalAccessAuth
Array<string>
Allowed values: ACCOUNT TWO_FACTOR_AUTH
globalActionAuth
Array<string>
Allowed values: ACCOUNT PASSKEY TWO_FACTOR_AUTH PASSWORD
folderId
string | null
templateType
string
Allowed values: PUBLIC PRIVATE ORGANISATION
meta
object
subject
string
<= 254 characters
message
string
<= 5000 characters
timezone
string
dateFormat
string
Allowed values: yyyy-MM-dd hh:mm a yyyy-MM-dd dd/MM/yyyy dd-MM-yyyy MM/dd/yyyy yy-MM-dd MMMM dd, yyyy EEEE, MMMM dd, yyyy dd/MM/yyyy hh:mm a dd/MM/yyyy HH:mm dd-MM-yyyy hh:mm a dd-MM-yyyy HH:mm MM/dd/yyyy hh:mm a MM/dd/yyyy HH:mm dd.MM.yyyy dd.MM.yyyy HH:mm yyyy-MM-dd HH:mm yy-MM-dd hh:mm a yy-MM-dd HH:mm yyyy-MM-dd HH:mm:ss MMMM dd, yyyy hh:mm a MMMM dd, yyyy HH:mm EEEE, MMMM dd, yyyy hh:mm a EEEE, MMMM dd, yyyy HH:mm yyyy-MM-dd'T'HH:mm:ss.SSSXXX
distributionMethod
string
Allowed values: EMAIL NONE
signingOrder
string
Allowed values: PARALLEL SEQUENTIAL
allowDictateNextSigner
boolean
redirectUrl
string
language
string
Allowed values: de en fr es it nl pl pt-BR ja ko zh
typedSignatureEnabled
boolean
uploadSignatureEnabled
boolean
drawSignatureEnabled
boolean
emailId
string | null
emailReplyTo
string | null
/^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\u{0080}-\u{FFFF}-]+@[a-zA-Z0-9\u{0080}-\u{FFFF}](?:[a-zA-Z0-9\u{0080}-\u{FFFF}-]{0,61}[a-zA-Z0-9\u{0080}-\u{FFFF}])?(?:\.[a-zA-Z0-9\u{0080}-\u{FFFF}](?:[a-zA-Z0-9\u{0080}-\u{FFFF}-]{0,61}[a-zA-Z0-9\u{0080}-\u{FFFF}])?)*$/
emailSettings
object
recipientSigningRequest
boolean
default: true
recipientRemoved
boolean
default: true
recipientSigned
boolean
default: true
documentPending
boolean
default: true
documentCompleted
boolean
default: true
documentDeleted
boolean
default: true
ownerDocumentCompleted
boolean
default: true
ownerRecipientExpired
boolean
default: true
ownerDocumentCreated
boolean
default: true
envelopeExpirationPeriod
Any of:
object
unit
required
string
Allowed values: day week month year
amount
required
integer
>= 1
reminderSettings
object
sendAfter
required
Any of:
object
unit
required
string
Allowed values: day week month
amount
required
integer
>= 1
repeatEvery
required
Any of:
object
unit
required
string
Allowed values: day week month
amount
required
integer
>= 1

Responses

Section titled “Responses”

200

Section titled “200”

Successful response

Media typeapplication/json
object
internalVersion
required
number
type
required
string
Allowed values: DOCUMENT TEMPLATE
status
required
string
Allowed values: DRAFT PENDING COMPLETED REJECTED CANCELLED
source
required
string
Allowed values: DOCUMENT TEMPLATE TEMPLATE_DIRECT_LINK
visibility
required
string
Allowed values: EVERYONE MANAGER_AND_ABOVE ADMIN
templateType
required
string
Allowed values: PUBLIC PRIVATE ORGANISATION
id
required
string
secondaryId
required
string
externalId
required
string | null
createdAt
required
string
updatedAt
required
string
completedAt
required
string | null
deletedAt
required
string | null
title
required
string
authOptions
required
object
globalAccessAuth
required
Array<string>
Allowed values: ACCOUNT TWO_FACTOR_AUTH
globalActionAuth
required
Array<string>
Allowed values: ACCOUNT PASSKEY TWO_FACTOR_AUTH PASSWORD
formValues
required
object | null
publicTitle
required
string
publicDescription
required
string
userId
required
number
teamId
required
number
folderId
required
string | null
Example
{
  "type": "DOCUMENT",
  "status": "DRAFT",
  "source": "DOCUMENT",
  "visibility": "EVERYONE",
  "templateType": "PUBLIC",
  "authOptions": {
    "globalAccessAuth": [
      "ACCOUNT"
    ],
    "globalActionAuth": [
      "ACCOUNT"
    ]
  }
}

400

Section titled “400”

Invalid input data

Media typeapplication/json
object
message
required
string
code
required
string
issues
Array<object>
object
message
required
string
Examplegenerated
{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

401

Section titled “401”

Authorization not provided

Media typeapplication/json
object
message
required
string
code
required
string
issues
Array<object>
object
message
required
string
Examplegenerated
{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

403

Section titled “403”

Insufficient access

Media typeapplication/json
object
message
required
string
code
required
string
issues
Array<object>
object
message
required
string
Examplegenerated
{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

500

Section titled “500”

Internal server error

Media typeapplication/json
object
message
required
string
code
required
string
issues
Array<object>
object
message
required
string
Examplegenerated
{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}