Documents Collaboration

Create/Update Document User Collaborator

Updates the collaborator role for a user on a document. If the user did not previously have access to the document, they will be granted access and a new collaborator record will be created.

put/v1/documents/{id}/shares/users/{userId}

Request

  • Base URL: https://api.lucid.co
  • URL: https://api.lucid.co/v1/documents/{id}/shares/users/{userId}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://lucid.app/oauth2/authorize, token URL https://api.lucid.co/oauth2/token, scopes: lucidchart.document.content.share.collaborator, lucidchart.document.app.picker.share.collaborator, lucidchart.document.app.folder, lucidscale.document.content.share.collaborator, lucidscale.document.app.picker.share.collaborator, lucidscale.document.app.folder, lucidspark.document.content.share.collaborator, lucidspark.document.app.picker.share.collaborator, lucidspark.document.app.folder)

Path parameters

idstring uuid required

ID of the document.

userIdnumber required

ID of the user 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 User Collaborator. Contains the updated Document User Collaborator Resource.

documentIdstring uuid required

Document ID

userIdinteger required

User 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

Changes

No recorded changes to this operation across all 1 revision of this API.