v1

latestOpenAPI 3.1.02026-08-066378446.6 KB

Document Operations

Update signatory

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

Updates the details of a signatory on a document.

Note: When updating a signatory who has an existing user in the current fynk account (has_account_user is true), only party_uuid and mobile_phone can be updated. Attempting to update other fields (first_name, last_name, title) will cause the request to be rejected with a validation error.

put/documents/{document}/signatories/{signatory}

Path parameters

documentstring required

The document UUID

signatorystring required

The signatory UUID

Request body

party_uuidstring uuid

UUID of the party the signatory will be signing for

first_namestring nullable

Cannot be updated if the signatory's has_account_user field is true

last_namestring nullable

Cannot be updated if the signatory's has_account_user field is true

mobile_phonestring nullable

Mobile phone number, in E.164 format, as shown in the example

titlestring nullable

Cannot be updated if the signatory's has_account_user field is true

Example request

{
  "party_uuid": "595703a2-b7f6-4772-a4b7-ab2f9fac3a9f",
  "first_name": "Emily",
  "last_name": "Miller",
  "mobile_phone": "+447951123456",
  "title": "Sales Manager"
}

Response

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