Grant permissions on a workbook to users or teams

You can use this endpoint to grant specific document permissions on a specific workbook to users or teams.

Usage notes

• Ensure the workbookId in the path is valid and that the user has rights to modify its permissions. Retrieve the workbookId by calling the /v2/workbooks endpoint.

• Do not set both memberId and teamId in the same grantee object. Instead, choose one based on the target of the grant.

  • Retrieve the memberId by calling the /v2/members endpoint.
  • Retrieve the teamId by calling the /v2/teams endpoint.

• Grant permissions on a specific version tag of a workbook by specifying the tagId. Retrieve the tagId by calling the /v2/tags endpoint and using the versionTagId in the response.

Usage scenarios

• Team collaboration: Granting edit permissions to a team for collaborative work on a project.
• External consultant: Providing view access to an external consultant.

Best practices

• Validate user and team IDs before submitting them in a request to avoid errors.
• Use the tagId to help manage and revoke grants systematically as project requirements change.