LUlucid
Documents Collaboration

Request Document Access

Changed on

Sends a request on behalf of the authenticated user asking the document's owner to grant them the provided role on the document.

post/v1/documents/{id}/requestAccess

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
      Scopeslucid.document.accessRequest, lucidchart.document.accessRequest, lucidspark.document.accessRequest, lucidscale.document.accessRequest
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring uuid required

ID of the document.

Request body

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.
messagestring required

Message to include with the access request sent to the document's owner.

Response

No Content. The access request was successfully sent.

Changes