Documents Sharing

Update Document Share Link

Updates an existing share link's configuration settings on a document. Share links will only be updatable by the OAuth2.0 client that created them. All fields are optional; omitted settings retain their existing values.

patch/v1/documents/{id}/shares/shareLinks/{shareLinkId}

Request

  • Base URL: https://api.lucid.co
  • URL: https://api.lucid.co/v1/documents/{id}/shares/shareLinks/{shareLinkId}
  • Auth: OAuth 2 (authorization code, authorization URL https://lucid.app/oauth2/authorize, token URL https://api.lucid.co/oauth2/token, scopes: lucidchart.document.content.share.link, lucidchart.document.app.picker.share.link, lucidchart.document.app.folder, lucidscale.document.content.share.link, lucidscale.document.app.picker.share.link, lucidscale.document.app.folder, lucidspark.document.content.share.link, lucidspark.document.app.picker.share.link, lucidspark.document.app.folder)

Path parameters

idstring uuid required

ID of the document.

shareLinkIdstring required

Id of the share link to retrieve information for.

Request body

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

Roles determine what actions an invitation will grant on a document. Invitations to a document only grant the specified level of access to just that one document. If a link's role is changed, the new role applies immediately to all users who accessed via that link.

  • editandshare: View, comment on, edit, and control which users can access the document.
  • edit: View, comment on, and edit the document.
  • comment: View the document. Leave comments on the document.
  • view: View the document.

Example request

{
  "linkSecurity": {
    "restrictToAccount": false,
    "expires": "2023-12-11T21:48:35.293Z",
    "passcode": "password",
    "allowAnonymous": false
  }
}

Response

OK with a Document Share Link resource containing information about the updated share link.

shareLinkIdstring required

Id of the share link.

documentIdstring uuid required

Id of the document the share link belongs to.

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

Roles determine what actions an invitation will grant on a document. Invitations to a document only grant the specified level of access to just that one document. If a link's role is changed, the new role applies immediately to all users who accessed via that link.

  • editandshare: View, comment on, edit, and control which users can access the document.
  • edit: View, comment on, and edit the document.
  • comment: View the document. Leave comments on the document.
  • view: View the document.
createdstring date-time required

The date and time the share link was created.

createdBynumber required

User Id of the user that created the share link.

lastModifiedstring date-time required

The date and time the share link was last modified.

acceptUrlstring uri required

Link to accept the share link invitation.

Example response

{
  "shareLinkId": "inv_8a38797a-e5fc-4479-8492-e000dc93cb60",
  "documentId": "f6bf19b5-d109-4ef5-92b2-cdaf0de43001",
  "linkSecurity": {
    "restrictToAccount": false,
    "expires": "2023-12-11T21:48:35.293Z",
    "passcode": "password",
    "allowAnonymous": false
  },
  "created": "2022-11-11T21:48:35.293Z",
  "createdBy": 1280,
  "lastModified": "2022-11-11T21:48:35.293Z",
  "acceptUrl": "https://lucid.app/lucidchart/f6bf19b5-d109-4ef5-92b2-cdaf0de43001/edit?invitationId=inv_8a38797a-e5fc-4479-8492-e000dc93cb60"
}

Changes

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