---
title: "Reorder documents"
method: POST
path: "/e-signature-packages/{eSignaturePackageId}/documents/actions/reorder"
tags: ["Documents - Actions"]
---

# Reorder documents

`POST /e-signature-packages/{eSignaturePackageId}/documents/actions/reorder`

## Request

- Base URL: `https://rest.api.pactima.com/v1`
- URL: `https://rest.api.pactima.com/v1/e-signature-packages/{eSignaturePackageId}/documents/actions/reorder`
- Auth: HTTP bearer

Reorder documents given a referenced array of document ids. The package must be in a draft status, (i.e. DRAFT or LIVE_EDITING)

## Request body

- object
  - `documentsOrder` string[]: Array of document ids by which to order the documents

## Response `200`

Returns the updated ESignatureTemplate object if successfully updated. Returns an error if the update parameters are invalid.

- ESignatureTemplate
  - `id` string, required
  - `isTestMode` boolean
  - `title` string, required
  - `description` string
  - `emailMessage` string
  - `documents` ESignatureTemplateDocument[]
    - `id` string
    - `name` string
    - `pageCount` number
    - `entryPads` ESignatureEntryPad[]
      - `id` string
      - `signerId` string, required: Id of the signer
      - `type` 'signature' | 'initials' | 'stamp' | 'date' | 'text' | 'checkbox' | 'name' | 'notary_public_profile_info' | 'email', required
      - `left` number, required: Offset from the left. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.
      - `top` number, required: Offset from the top. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.
      - `height` number, required: Height of the entry pad. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.
      - `width` number, required: Width of the entry pad. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.
      - `pageIndex` number, required: Page index whereby the entry pad is contained in the document.
      - `isOptional` boolean: Set to true if the entry pad is optional.
      - `metadata` unknown
  - `signers` ESignatureTemplateSigner[]
    - `id` string, required
    - `name` string, required
    - `attachmentRequests` ESignatureSignerAttachmentRequest[]
      - `id` string
      - `name` string, required
      - `description` string
      - `isOptional` boolean: Set to true if the request is optional
      - `isConfidential` boolean: Set to true if the attachment should not be shared with other signers; only the owner
    - `specialRoles` ESignatureSignerSpecialRoleEnum[]
    - `viewRestrictions` ESignatureSignerViewRestrictionEnum[]
  - `ccRecipients` ESignatureTemplateRecipient[]
    - `id` string, required
    - `name` string, required
  - `orderedSigners` boolean: Signers are sent by order
  - `owner` string
  - `kind` 'REGULAR' | 'EASY_SIGN'
  - `packageFolderId` string: Package folder that the esp is part of
  - `customBrandItemId` string: Id of the applicable custom brand item to apply to this eSignature template
  - `customBrandItem` CustomBrandItem
    - `id` string
    - `ownerId` string: Public id of the owner
    - `name` string, required: Name of the custom brand item
    - `logoSrc` string, required: Url of the logo
    - `isDefault` boolean: Mark whether the default is default
    - `emailNotification` CustomBrandItemEmailNotification
      - `senderName` string, required: The name that is sent when an email from Snapdocs RON (formerly Pactima) is sent out. Placeholders {{firstName}} and {{lastName}} can be used
      - `colorTheme` object, required
        - `headerBackground` string, required
        - `headerText` string, required
        - `buttonBackground` string, required
        - `buttonText` string, required
        - `linkColor` string, required
    - `signingCeremony` CustomBrandItemSigningCeremony, required
      - `colorTheme` object, required
        - `headerBackground` string, required
        - `buttonBackground` string, required
        - `buttonText` string, required
    - `whiteLabelConfig` CustomBrandItemWhiteLabelConfig
      - `domainNames` string[]
      - `rootCSS` object
      - `notificationEmailAddress` string, email
      - `footerDetails` object
        - `inlineItems` string[]
        - `copyrightItem` string, html
      - `pathsConfig` object
        - `basePath` string
        - `basePathAuthenticated` string
  - `ownerDetails` OwnerDetails
    - `firstName` string
    - `lastName` string
    - `publicId` string
    - `email` string
  - `allTemplateFields` ESignatureTemplateField[]
    - `name` string, required
    - `required` boolean

## Changes

- **2026-11-03** `263938e87b8b`: 1 breaking
  - the `ownerDetails/allOf[#/components/schemas/OwnerDetails]/` response's property type changed from no type to `object` for status `200`

[Operation history](https://skmtc.dev/pactima/apis/esignature-packages-api/changes/e-signature-packages/:eSignaturePackageId/documents/actions/reorder/post.md)

---

[API](https://skmtc.dev/pactima/apis/esignature-packages-api.md) - [All operations](https://skmtc.dev/pactima/apis/esignature-packages-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pactima/apis/esignature-packages-api/revisions/263938e87b8b?raw)