Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

Jump to
slack_kit priv docs methods admin.conversations.convertToPrivate.json
Raw

priv/docs/methods/admin.conversations.convertToPrivate.json

{
"args": {
"channel_id": {
"desc": "The channel to convert to private.",
"example": "C12345",
"required": true
},
"name": {
"desc": "Name of private channel to create. Only respected when converting an MPIM.",
"example": "new_private_channel_name",
"required": false,
"type": "string"
}
},
"desc": "Convert a public channel to a private channel.",
"errors": {
"channel_not_found": "The value passed for `channel` was invalid.",
"channel_type_not_supported": "The value passed for `channel` was a DM, MPDM, private, or the 'general' channel.",
"could_not_convert_channel": "This channel could not be converted to private.",
"default_org_wide_channel": "The default org-wide channel cannot be converted to private.",
"external_channel_migrating": "This external channel is migrating, so it can't be converted to private.",
"feature_not_enabled": "The provided token doesn't have access to this method.",
"method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.",
"name_taken": "A private channel cannot be created with the given name.",
"restricted_action": "A workspace preference prevents the authenticated user from creating private channels."
},
"rate_limit": {
"label": "Tier 2: 20+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"user": [
{
"name": "admin.conversations:write",
"url": "https://docs.slack.dev/reference/scopes/admin.conversations.write"
}
]
}
}