GOgonitro
Sign

Update Document by ID

The Update Document by ID endpoint allows you to update an existing document's metadata within an envelope. This endpoint performs a partial update on the document, changing only the provided fields while preserving all other properties. Currently, only the document name can be updated.

patch/sign/envelopes/{envelopeID}/documents/{documentID}

Request

  • Base URL
    https://api.gonitro.dev
  • URL
    https://api.gonitro.dev/sign/envelopes/{envelopeID}/documents/{documentID}
  • Auth
    HTTP bearer

Path parameters

envelopeIDstring uuid required

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

documentIDstring uuid required

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

Request body

namestring required

The new name for the document

Example request

{
  "name": "Updated Document Name.pdf"
}

Response

Document updated successfully

OR

Changes

No recorded changes to this operation across all 8 revisions of this API.