Sign in

v1

latestOpenAPI 3.0.3Lucid2026-07-14155181312.3 KB
Documents Collaboration

Create/Update Document Team Collaborator

Updates the details of the given team's collaboration on the given document, or adds the team as a collaborator on the document if it isn't already a collaborator.

put/v1/documents/{id}/shares/teams/{teamId}

Path parameters

idstring uuid required

ID of the document.

teamIdnumber required

ID of the team to retrieve collaborator settings for.

Request body

role'editandshare' | 'edit' | 'comment' | 'view'

The Collaborator Role to assign to the user for this document.

Example request

{
  "role": "comment"
}

Response

OK when updating an existing Document Team Collaborator. Contains the updated Document Team Collaborator Resource.

documentIdstring uuid required

Document ID

teamIdinteger required

Team ID

role'owner' | 'editandshare' | 'edit' | 'comment' | 'view' required

The Collaborator Role on the document or folder

createdstring date-time required

Date and time when the collaboration was created