Request Document Access

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

Path Params
uuid
required

ID of the document.

Body Params
string
enum
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.
Allowed:
string
required

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

Responses
204

No Content. The access request was successfully sent.

403

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

429

Too Many Requests if the user has sent too many access requests for the document. The Retry-After header indicates how long to wait before retrying.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here!