Create Document Share Link

post https://api.lucid.co/documents/{id}/shares/shareLinks

Creates a new share link on the provided document with the provided settings.

📘
Note: The linkSecurity is only configurable for users on accounts with an enterprise license but is still required for team accounts. For more information see here.
Note: If an expiration is provided outside the account defined limits, it will clamp to be the maximum possible time.
Note: If the restrictToAccount field is provided as false and the document's account defined settings do not allow share links outside the account, it will restrict the share link to be within the account.

Valid Authentication Methods

OAuth 2.0 User 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

Responses

400

Bad Request if the document does not belong to an enterprise account and the restrictToAccount is set to true, defines a passcode, or defines an expiration or the allowAnonymous field is set to true on non-Lucidspark/Lucidchart documents.

403

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

Language

Credentials

OAuth2


xxxxxxxxxx
14
1
curl --request POST \
2
     --url https://api.lucid.co/documents/id/shares/shareLinks \
3
     --header 'Lucid-Api-Version: 1' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json' \
6
     --data '
7
{
8
  "role": "editandshare",
9
  "linkSecurity": {
10
    "restrictToAccount": true,
11
    "allowAnonymous": true
12
  }
13
}
14
'


xxxxxxxxxx
15
 
1
{
2
  "shareLinkId": "inv_8a38797a-e5fc-4479-8492-e000dc93cb60",
3
  "documentId": "f6bf19b5-d109-4ef5-92b2-cdaf0de43001",
4
  "role": "editandshare",
5
  "linkSecurity": {
6
    "restrictToAccount": false,
7
    "expires": "2023-12-11T21:48:35.293Z",
8
    "passcode": "password",
9
    "allowAnonymous": false
10
  },
11
  "created": "2022-11-11T21:48:35.293Z",
12
  "createdBy": 1280,
13
  "lastModified": "2022-11-11T21:48:35.293Z",
14
  "acceptUrl": "https://lucid.app/lucidchart/f6bf19b5-d109-4ef5-92b2-cdaf0de43001/edit?invitationId=inv_8a38797a-e5fc-4479-8492-e000dc93cb60"
15
}

📘

Valid Authentication Methods

OAuth 2.0 User Token Scopes:

201Created with a Document Share Link resource containing information about the created share link.