Document Operations

Set signing order

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

PUT

/documents/{document}/signatories/order

Set signing order

curl --request PUT \
  --url https://app.fynk.com/v1/api/documents/{document}/signatories/order \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "signing_order": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

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

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.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

documentstringrequired

The document UUID

Body

signing_orderstring[]required

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

Response

Array of SignatoryResource

dataobject[]required

Show child attributes

Still need help? Share an idea