Sign in

v4

OpenAPI 3.1.02026-07-313621,3961.8 MB
workspace

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.

post/v1/workspace/resources/{resource_id}/share

Path parameters

resource_idstring required

The ID of the target resource.

The ID of the target resource.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

role'admin' | 'editor' | 'commenter' | 'viewer' required

Role to grant to the target: one of 'admin', 'editor', 'commenter', or 'viewer'.

resource_type'voice' | 'voice_collection' | 'pronunciation_dictionary' | 'dubbing' | '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' | 'content_generations' | 'content_templates' | 'songs' | 'transcription_tasks' | 'avatars' | 'avatar_video_generations' | 'resource_collection' | 'studio_projects' | 'convai_analysis_items' required

Resource types that can be shared in the workspace. The name always need to match the collection names

user_emailstring nullable

The email of the user or service account.

group_idstring nullable

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, group membership, or workspace (service account) API key.

workspace_api_key_idstring nullable

The ID of the target workspace (service account) API key. This is not the API key string itself that you pass in the header for authentication — it is the key's ID, which workspace admins can find under Developers → Service Accounts.

Response

Successful Response

{"stackTrail":"paths:/v1/workspace/resources/{resource_id}/share:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}