action stream_io_api_delete_users { label: "Delete Users" description: "Deletes users and optionally all their belongings asynchronously." provider: stream_io_api method: POST path: "/users/delete" encoding: json input: { type: "object" required: ["user_ids"] properties: { conversations: { type: "string" description: "Conversation channels delete mode.\nConversation channel is any channel which only has two members one of which is the user being deleted.\n\n* null or empty string - doesn't delete any conversation channels\n* soft - marks all conversation channels as deleted (same effect as Delete Channels with 'hard' option disabled)\n* hard - deletes channel and all its data completely including messages (same effect as Delete Channels with 'hard' option enabled)\n" enum: ["soft", "hard"] } messages: { type: "string" description: "Message delete mode.\n\n* null or empty string - doesn't delete user messages\n* soft - marks all user messages as deleted without removing any related message data\n* pruning - marks all user messages as deleted, nullifies message information and removes some message data such as reactions and flags\n* hard - deletes messages completely with all related information\n" enum: ["soft", "pruning", "hard"] } new_channel_owner_id: { type: "string" } user: { type: "string" description: "User delete mode.\n\n* soft - marks user as deleted and retains all user data\n* pruning - marks user as deleted and nullifies user information\n* hard - deletes user completely. Requires 'hard' option for messages and conversations as well\n" enum: ["soft", "pruning", "hard"] } user_ids: { type: "array" description: "IDs of users to delete" items: { type: "string" } } } } output: { type: "object" required: ["duration", "task_id"] properties: { duration: { type: "string" description: "Duration of the request in human-readable format" } task_id: { type: "string" } } } }