Reorder Documents in an Envelope

This endpoint allows you to define the order in which documents are displayed within a specific envelope. It is useful when the reading or signing order of the documents matters.

Reorder documents

PUT https://api.zapsign.com.br/api/v1/docs/{doc_token}/document-display-order/

Conditions

• The document identified by doc_token must be an envelope (i.e., a document that groups multiple files).

• The envelope must be in progress.

• You must include all the document tokens that are part of the envelope, in the desired order. These tokens are available in the response when the document is created or from the document details.

Path Parameters

Name	Type	Description
doc_token	string	Document token

Headers

Name	Type	Description
Authorization*	string	apiToken ahead of the "Bearer" text. Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Body

Field	Type	Description
document_display_order	array of string	Ordered list of document tokens indicating the new display order.

Body

{
  "document_display_order": [
    "6a4c7b7d-433e-4faf-a4b1-1f96bbf72c68",    
    "09d983a1-7c26-472a-a2ef-8ee10470b5ed",
    "9f8c63bb-eb1b-461d-8ede-0ae90d75c18a"
  ]
}

200 Success.

{
    "message": "Document successfully updated"
}