Sign in

v1

latestOpenAPI 3.1.02026-08-066378446.6 KB
Document Operations

Add document user

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

Gives a person access to a document with the specified access level (role). By default the user receives an invitation email for the document; pass invite_method to instead create a personal link for them (returned in the response's personal_link field) or to add them silently.

With fynk_email, the invitation email to a user without a fynk account user in your account carries the document's default text for external collaborator invitations, if one is set on the document or inherited from its template. This text is configured in fynk and is not part of the API.

Note: When adding a user whose email corresponds to an existing user in the current fynk account, only email and role are used. Any additional fields (first_name, last_name, title) will be ignored and the user's information will be populated from their existing profile. Only such users can be given the owner role, and they cannot be added with the personal_link invite method.

Note: Users without a fynk account user in your account cannot be added while the document is in the draft or approved_draft stage, regardless of the invite method. Attempting to do so will return a 409 response.

If the email address already belongs to a document user on this document, the request will be rejected with a validation error - use the Update document user endpoint to change their access level instead. This includes signatories, who always appear as document users as well.

post/documents/{document}/users

Path parameters

documentstring required

The document UUID

Request body

emailstring email required

The user's email address

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

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.

invite_method'fynk_email' | 'personal_link' | 'none'

How a newly added document user is given access to the document.

fynk_email <br/> The user receives a fynk invitation email (the default).
personal_link <br/> A personal link is created for the user; delivering it is up to the API consumer.
none <br/> The user is added silently.
party_uuidstring uuid nullable

UUID of the party the user belongs to

first_namestring nullable

Ignored when the email corresponds to an existing user in the current fynk account

last_namestring nullable

Ignored when the email corresponds to an existing user in the current fynk account

titlestring nullable

Ignored when the email corresponds to an existing user in the current fynk account

Example request

{
  "email": "miller@example.com",
  "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."
    }
  }
}