Update envelope

Updates envelope metadata. Only works for draft envelopes.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Envelope ID to update

Body Params

Updated envelope data

Envelope creation request

string
required
length between 1 and 200

Envelope title

string | null

Envelope description (optional)

documentIds
array of uuids
required
length ≥ 1

Document IDs to include in envelope

documentIds*
string
required
length ≥ 1

Envelope routing mode.
Allowed values: "sequential" (strict order 1, 2, 3...), "parallel" (everyone at once).

recipients
array of objects
required
length ≥ 1

List of recipients/signers

recipients*
date-time | null

Envelope expiration date (optional)

metadata
object | null

Optional metadata for workflow conditions (value, department, type, priority)

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json