FIfirma
Signing Requests

Reorder a signing request's documents

Changed on

Sets the order of the signing request's documents. document_ids must name every document of the signing request exactly once: a missing or repeated id answers 400 INVALID_DOCUMENT_ORDER, an id that is not a document of this signing request 404 DOCUMENT_NOT_FOUND. A sent, finished, cancelled or declined signing request answers 409 DOCUMENT_SET_LOCKED.

Available to every company. This operation is part of the multi-document contract (API 01.39.00). For a signing request or template the API key cannot see, it answers 404 with code NOT_FOUND ("Endpoint not found"), exactly as an unknown endpoint does. While multi-document editing is suspended, this operation returns 409 MULTI_DOCUMENT_READ_ONLY for parents on the multi-document read-only path and 404 NOT_FOUND for parents on the single-document path.

put/signing-requests/{id}/documents/order

Request

Path parameters

idstring uuid required

Signing request ID

Request body

document_idsstring[] required

Every document id of the set (documents[].document_id), in the new order.

Response

Documents reordered; the full document set after the change

documents_versioninteger required
documents_layout_versioninteger required

Example response

{
  "documents": [
    {
      "document_id": null,
      "position": 1,
      "label": null,
      "original_filename": null,
      "page_count": 3,
      "document_url": "https://api.firma.dev/storage/v1/object/sign/signing-request-documents/example.pdf?token=example",
      "document_url_kind": "stored",
      "document_only_hash": null
    }
  ]
}

Changes