Skip to main content
PUT
/
sign
/
envelopes
/
{envelopeID}
/
documents:reorder
Reorder Documents by Envelope ID
curl --request PUT \
  --url https://api.gonitro.dev/sign/envelopes/{envelopeID}/documents:reorder \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "order": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "items": [
    {
      "ID": "987e6543-e21b-12d3-a456-426614174999",
      "name": "First Document",
      "statue": "pending",
      "createdAt": "2023-11-07T05:31:56Z"
    },
    {
      "ID": "bc58d090-1368-4764-96b2-e59f8e4c0e0c",
      "name": "Second Document",
      "statue": "pending",
      "createdAt": "2023-11-08T05: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.

Body

application/json

The request body should contain an array named 'order' with the document IDs in the desired sequence. This will update the order of documents within the envelope according to the provided list.

Example:

{
  "order": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "ffa85f64-5709-6562-g3fc-1c963f66afa5"
  ]
}
​
order
string<uuid>[]

An array of document IDs representing the new order of documents within the envelope.

Response

Documents reordered 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