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.

Update the collaborator role for a user.

  • If the user did not have access to the document before, they will be granted access and a new Document User Collaborator Resource will be created.

Valid Authentication Methods

API Key Grants:

  • DocumentEdit

OAuth 2.0 User 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 Params
uuid
required

ID of the document.

number
required

ID of the user to retrieve collaborator settings for.

Body Params
string
enum

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

Allowed:
Responses

403

Forbidden if the token does not have permission to the document, or if the document has been deleted or does not exist.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json