PUT
/
envelope
/
{envelope_id}
/
void

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
envelope_id
string
required

Response

200 - application/json
​
comment
string

Comment for the envelope

​
created_at
integer

Unix timestamp of the creation date

​
documents
object[]
​
expires_at
integer

Unix timestamp of the expiration date

​
flow_type
enum<string>

Flow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow)

Available options:
REQUEST_SIGNATURE,
SIGN_MYSELF
​
id
string

Unique identifier of the envelope

​
is_duplicable
boolean

Whether the envelope can be duplicated

​
legality_level
enum<string>

Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes)

Available options:
SES,
QES_EIDAS,
QES_ZERTES
​
name
string

Name of the envelope

​
notification
object
​
num_recipients
integer

Number of recipients in the envelope

​
pages
integer

Total number of pages in the envelope

​
signing_steps
object[]
​
status
enum<string>

Status of the envelope

Available options:
DRAFT,
IN_PROGRESS,
COMPLETED,
EXPIRED,
DECLINED,
VOIDED,
PENDING
​
updated_at
integer

Unix timestamp of the last modification date

Duplicate envelopeRename envelope