LUlucid
Documents Collaboration

Create/Update Document Team Collaborator

Changed on

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/v2/documents/{id}/shares/teams/{teamId}

Request

  • Base URL
    https://api.lucid.co
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization codehttps://lucid.app/oauth2/authorize
      Token URLhttps://api.lucid.co/oauth2/token
      Scopeslucidchart.document.app.folder, lucidchart.document.app.picker.share.collaborator, lucidchart.document.content.share.collaborator, lucidscale.document.app.folder, lucidscale.document.app.picker.share.collaborator, lucidscale.document.content.share.collaborator, lucidspark.document.app.folder, lucidspark.document.app.picker.share.collaborator, lucidspark.document.content.share.collaborator
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring uuid required

ID of the document.

teamIdstring required

ID of the team to retrieve collaborator settings for, prefixed with team_. The legacy numeric team ID is also accepted.

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

teamIdstring required

Team ID prefixed with team_.

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

Example response

{
  "teamId": "team_99"
}

Changes