latestOpenAPI 3.0.02026-08-081631260.8 KB

ae9d64e51a99

Document sharing

Share a document

Shares a document to a user specified by email

post/documents/{id}/share

idstring uuid required

Example:1e013958-867e-43fb-8210-c98ab139beb6

Document ID

assigned_data_field_idsstring[]

List of data fields IDs this user can update if their role is set to filler

can_access_private_commentsboolean

Allows accessing private comments if set to true.

It is always true for manager role.

For other roles, it can be set using this parameter.

can_access_private_historyboolean

Allows accessing private comments if set to true.

can_send_for_signatureboolean

Allows sending for signature if set to true.

It is always true for manager role and always false for reviewer role.

For other roles, it can be set using this parameter.

emailstring email required

User's email

messagestring required

Message to the user. If you don't have it, send an empty string.

role'manager' | 'editor' | 'filler' | 'reviewer' required

User's role

{
  "assigned_data_field_ids": [
    "d5bcbcdb-552a-4419-bbff-c7fe3cc6837c"
  ]
}

Success