Share Workspace Resource
Grants a role (one of ‘admin’, ‘editor’, ‘commenter’, or ‘viewer’) on a workspace resource to a user, group, or workspace (service account) API key. This overrides any existing role the target has on the resource. To target a user or service account, pass only the user email; the user must be in your workspace. To target a group, pass only the group id. To target a workspace (service account) API key, pass the api key id; the resource will be shared with the service account associated with that key. You must have admin access to the resource to share it.
Headers
Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.
Path Parameters
The ID of the target resource.
Body
Role to grant to the target: one of 'admin', 'editor', 'commenter', or 'viewer'.
admin, editor, commenter, viewer Resource type of the target resource.
voice, voice_collection, pronunciation_dictionary, project, convai_agents, convai_knowledge_base_documents, convai_tools, convai_settings, convai_secrets, workspace_auth_connections, convai_phone_numbers, convai_mcp_servers, convai_api_integration_connections, convai_api_integration_trigger_connections, convai_batch_calls, convai_agent_response_tests, convai_test_suite_invocations, convai_crawl_jobs, convai_crawl_tasks, convai_kb_external_sync_jobs, convai_whatsapp_accounts, convai_agent_versions, convai_agent_branches, convai_agent_versions_deployments, convai_memory_entries, convai_coaching_proposals, convai_templates, dashboard, dashboard_configuration, convai_agent_drafts, resource_locators, assets, transcription_tasks, avatars, resource_collection, convai_analysis_items The email of the user.
The ID of the target group. Use 'default' to set the resource's baseline role - every workspace member receives this role unless they hold a higher one through a direct user grant, or group membership.
Deprecated. Sharing resources with service-account API keys has been removed; service accounts will return through WorkOS M2M.
Response
Successful Response