Skip to main content
PATCH
Update Document by ID

Authorizations

Authorization
string
header
required

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

Path Parameters

envelopeID
string<uuid>
required

A unique UUIDv4 string that identifies the envelope in the Nitro system.

documentID
string<uuid>
required

A unique string that identifies the document in the Nitro system.

Body

application/json
name
string
required

The new name for the document

Required string length: 1 - 255
Example:

"Updated Document Name.pdf"

Response

Document updated successfully

Response for a pending document

name
string
required

Name of the file provided by the user.

Minimum string length: 1
ID
string<uuid>
required

Unique uuid identifier for the document.

Minimum string length: 1
createdAt
string<date-time>

UTC timestamp indicating when the document was created.

status
enum<string>

Current status of the document.

Available options:
pending,
uploaded,
failed,
signed,
sealed