FYfynk
Document Operations

Update document user

Changed on

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

Updates a document user's details and/or access level (role).

Changing the role never affects the user's signatory status - a signatory who is demoted to viewer remains a signatory. Use the signatory endpoints to manage signing.

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

A document must always have at least one owner; demoting the last owner will return a 409 response.

put/documents/{document}/users/{documentUser}

Request

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

Path parameters

documentstring required

The document UUID

documentUserstring required

The document user UUID

Request body

role'owner' | 'collaborator' | 'viewer'

The representation of a document user's access level in the external API. Internally the access level is held in the document user's roles (where a plain viewer simply has no role); the external API always exposes it as one of these three values.

party_uuidstring uuid

UUID of the party the user belongs to

first_namestring nullable

Cannot be updated if the document user's has_account_user field is true

last_namestring nullable

Cannot be updated if the document user's has_account_user field is true

titlestring nullable

Cannot be updated if the document user's has_account_user field is true

Example request

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

Response

DocumentUserResource

Example response

{
  "data": {
    "uuid": "76b8e0ad-e9cd-4c21-98b1-cd0003423ec2",
    "first_name": "Emily",
    "last_name": "Miller",
    "email": "miller@example.com",
    "title": "Sales Manager",
    "party_uuid": "595703a2-b7f6-4772-a4b7-ab2f9fac3a9f",
    "personal_link": {
      "uuid": "5cbe6ed1-49a9-40dc-a1c4-9e5a3c9a08f0",
      "url": "https:app.fynk.com/share/5cbe6ed1-49a9-40dc-a1c4-9e5a3c9a08f0?token=...",
      "expires_at": "2026-10-19T12:00:00Z",
      "message": "Hi Emily, please review the updated contract."
    }
  }
}

Changes