Create/Update Document User Collaborator

put https://api.lucid.co/documents/{id}/shares/users/{userId}

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

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


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://api.lucid.co/documents/id/shares/users/userId \
3
     --header 'Lucid-Api-Version: 1' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json'


xxxxxxxxxx
 
1
{
2
  "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3
  "userId": 0,
4
  "role": "owner",
5
  "created": "2025-04-03T17:09:56.426Z"
6
}

Valid Authentication Methods

API Key Grants:

OAuth 2.0 User Token Scopes:

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

201Created when creating a new Document User Collaborator. Contains the new Document User Collaborator Resource.