Create or update a grant

Create a grant or update an existing grant on a document, folder, or workspace to a user or a team by ID.

Usage notes

  • This endpoint can only be used to escalate the level of access that a user has to a document. To remove or reduce a user's access to a specific document, call /v2/grants/{grantId} to delete the existing grant and re-grant the desired level of access.
  • Retrieve the memberId by calling the /v2/members endpoint.
  • Retrieve the teamId by calling the /v2/teams endpoint.
  • Retrieve the inodeId by calling the /v2/files endpoint and using the id included in the response.
  • Retrieve the inodeId for a data model by calling the /v2/dataModels endpoint and using the dataModelId included in the response.
  • Optionally specify a tagId to associate the permission with a specific version tag of a workbook, dataset (deprecated), or database table. Retrieve the tagId by calling the /v2/tags endpoint and using the versionTagId included in the response.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The request body.

grantee
required
enum
required
string
required
string
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json