Skip to main content
Document Operations

Add document user

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

POST
/documents/{document}/users

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.

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

documentstringrequired

The document UUID

Body

application/json
emailstringrequired

The user's email address

Maximum string length: 255
Example: miller@example.com
first_namestring | null

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

Maximum string length: 255
Example: Emily
invite_methodenum<string>default:fynk_email

How the user is given access to the document. fynk_email (the default) sends the user an invitation email. personal_link creates a personal link for the user and returns it in the response; delivering the link is up to you. none adds the user silently. Note that personal_link is only available for users without a fynk account user in your account

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.
Available options: fynk_email, personal_link, none
last_namestring | null

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

Maximum string length: 255
Example: Miller
party_uuidstring | null

UUID of the party the user belongs to

Example: 595703a2-b7f6-4772-a4b7-ab2f9fac3a9f
roleenum<string>required

The user's access level on the document. Note that only users with a fynk account user in your account can become an owner

Available options: owner, collaborator, viewer
titlestring | null

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

Maximum string length: 255
Example: Sales Manager

Response

application/json

DocumentUserResource

dataobjectrequired

Still need help? Share an idea