conversationsKick
Removes a user from a conversation.
Details
- Method:
POST - Path:
/conversations.kick - Operation ID:
conversations_kick
Parameters
{
"token": {
"description": "Authentication token. Requires scope: `conversations:write`",
"required": false,
"location": "header",
"type": "string"
},
"channel": {
"description": "ID of conversation to remove user from.",
"required": false,
"location": "formData",
"type": "string"
},
"user": {
"description": "User ID to be removed.",
"required": false,
"location": "formData",
"type": "string"
}
}Response Schema
{
"additionalProperties": false,
"description": "Schema for successful response conversations.kick method",
"properties": {
"ok": {
"enum": [
true
],
"title": "default success response",
"type": "boolean"
}
},
"required": [
"ok"
],
"title": "conversations.kick success schema",
"type": "object"
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('slack')
# Call this tool
result = await agent.call_tool('conversationsKick', {
# Add required parameters here
})