{ "name": "ShareTaskWithGuest", "fully_qualified_name": "ClickupApi.ShareTaskWithGuest@0.1.0", "description": "Share a task with a guest in the ClickUp Workspace.\n\nThis tool shares a specified task with a guest, available only on ClickUp's Enterprise Plan.", "toolkit": { "name": "ClickupApi", "description": null, "version": "0.1.0" }, "input": { "parameters": [ { "name": "task_id", "required": true, "description": "The unique identifier for the task to share with the guest.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "" }, "inferrable": true, "http_endpoint_parameter_name": "task_id" }, { "name": "guest_id", "required": true, "description": "The unique identifier for the guest to share the task with.", "value_schema": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "" }, "inferrable": true, "http_endpoint_parameter_name": "guest_id" }, { "name": "guest_permission_level", "required": true, "description": "Defines the level of access for the guest. Options: 'read', 'comment', 'edit', 'create'.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Can be `read` (view only), `comment`, `edit`, or `create` (full)." }, "inferrable": true, "http_endpoint_parameter_name": "permission_level" }, { "name": "workspace_id_when_custom_task_ids_enabled", "required": false, "description": "Provide the Workspace ID when referencing tasks by custom task IDs. Required if `custom_task_ids` is `true`.", "value_schema": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." }, "inferrable": true, "http_endpoint_parameter_name": "team_id" }, { "name": "include_shared_details", "required": false, "description": "Set to `true` to include details of items shared with the guest. Defaults to `true`.", "value_schema": { "val_type": "boolean", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`." }, "inferrable": true, "http_endpoint_parameter_name": "include_shared" }, { "name": "use_custom_task_ids", "required": false, "description": "Set to true to reference a task by its custom task ID.", "value_schema": { "val_type": "boolean", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "If you want to reference a task by it's custom task id, this value must be `true`." }, "inferrable": true, "http_endpoint_parameter_name": "custom_task_ids" } ] }, "output": { "description": "Response from the API endpoint 'AddGuestToTask'.", "available_modes": [ "value", "error", "null" ], "value_schema": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": null } }, "requirements": { "authorization": { "provider_id": "arcade-clickup", "provider_type": "oauth2", "id": null, "oauth2": null }, "secrets": null, "metadata": null }, "deprecation_message": null, "metadata": { "object_type": "api_wrapper_tool", "version": "1.1.0", "description": "Tools that enable LLMs to interact directly with the clickup API." }, "http_endpoint": { "metadata": { "object_type": "http_endpoint", "version": "1.2.0", "description": "" }, "url": "https://api.clickup.com/api/v2/task/{task_id}/guest/{guest_id}", "http_method": "POST", "headers": {}, "parameters": [ { "name": "include_shared", "tool_parameter_name": "include_shared_details", "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.", "value_schema": { "val_type": "boolean", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`." }, "accepted_as": "query", "required": false, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "custom_task_ids", "tool_parameter_name": "use_custom_task_ids", "description": "If you want to reference a task by it's custom task id, this value must be `true`.", "value_schema": { "val_type": "boolean", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "If you want to reference a task by it's custom task id, this value must be `true`." }, "accepted_as": "query", "required": false, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "team_id", "tool_parameter_name": "workspace_id_when_custom_task_ids_enabled", "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", "value_schema": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." }, "accepted_as": "query", "required": false, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "task_id", "tool_parameter_name": "task_id", "description": "", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "" }, "accepted_as": "path", "required": true, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "guest_id", "tool_parameter_name": "guest_id", "description": "", "value_schema": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "" }, "accepted_as": "path", "required": true, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "permission_level", "tool_parameter_name": "guest_permission_level", "description": "Can be `read` (view only), `comment`, `edit`, or `create` (full).", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Can be `read` (view only), `comment`, `edit`, or `create` (full)." }, "accepted_as": "body", "required": true, "deprecated": false, "default": null, "documentation_urls": [] } ], "documentation_urls": [], "secrets": [ { "arcade_key": "auth_token", "parameter_name": "Authorization", "accepted_as": "header", "formatted_value": "Bearer {authorization}", "description": "The OAuth token to use for authentication.", "is_auth_token": true } ], "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"AddGuestToTaskrequest\",\n \"required\": [\n \"permission_level\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"permission_level\": {\n \"description\": \"Can be `read` (view only), `comment`, `edit`, or `create` (full).\",\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"permission_level\": \"read\"\n }\n ]\n },\n \"example\": {\n \"permission_level\": \"read\"\n }\n }\n },\n \"required\": true\n}", "use_request_body_schema_mode": false, "validate_request_body_schema": false } }