Document Operations

Set signing order

Changed on

<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.

The signing_order array must contain the UUIDs of all of the document's signatories, in the order in which they should sign. Signatories are assigned a signing_order as they are added to the document, so this endpoint is only needed to change that initial order. Signatories who pre-signed the document's template sign as soon as the signing stage starts, so they are always placed first, ahead of the order sent.

For this to have an effect, this request must be made before moving the document to the signing stage, and the signing process must use sequential signing.

put/documents/{document}/signatories/order

Request

  • Base URL
    https://app.fynk.com/v1/api
  • URL
    https://app.fynk.com/v1/api/documents/{document}/signatories/order
  • Auth
    HTTP bearer

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"
    }
  ]
}

Changes