v1

latestOpenAPI 3.1.02026-08-066378446.6 KB

Document Operations

Set signing order

<small>Requires an API token with the Document Manager role.</small>

Set the order in which signatures will be collected from the document's signatories.

For this to have an effect, this request must be made before moving the document to the signing stage, and signing must be started with the sequential_signing option enabled.

put/documents/{document}/signatories/order

Path parameters

documentstring required

The document UUID

Request body

signing_orderstring[] required

The UUIDs of the document's signatories, in the order in which they should sign

Response

Array of SignatoryResource

Example response

{
  "data": [
    {
      "uuid": "76b8e0ad-e9cd-4c21-98b1-cd0003423ec2",
      "first_name": "Emily",
      "last_name": "Miller",
      "email": "miller@example.com",
      "mobile_phone": "+447951123456",
      "title": "Sales Manager",
      "profile_photo_url": "https://ui-avatars.com/api/?name=EM",
      "party_uuid": "595703a2-b7f6-4772-a4b7-ab2f9fac3a9f"
    }
  ]
}