Update Document by ID

PATCH

sign

envelopes

{envelopeID}

documents

{documentID}

Update Document by ID

curl --request PATCH \
  --url https://api.gonitro.dev/sign/envelopes/{envelopeID}/documents/{documentID} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Document Name.pdf"
}
'

{
  "name": "<string>",
  "ID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z"
}

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

Pending
Uploaded

Response for a pending document

name

string

required

Name of the file provided by the user.

Minimum string length: 1

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

Download Sealed Document by IDThe **Download Sealed Document by ID** downloads a single sealed (signed) document as a PDF from a sealed envelope.

Update Document by ID

curl --request PATCH \
  --url https://api.gonitro.dev/sign/envelopes/{envelopeID}/documents/{documentID} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Document Name.pdf"
}
'

{
  "name": "<string>",
  "ID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z"
}