Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

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

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

{
"args": {
"description": {
"desc": "Description of the public or private channel to create.",
"example": "It's a good channel, Bront.",
"required": false,
"type": "string"
},
"is_private": {
"desc": "When `true`, creates a private channel instead of a public channel",
"example": "true",
"required": true,
"type": "boolean"
},
"name": {
"desc": "Name of the public or private channel to create.",
"example": "mychannel",
"required": true,
"type": "string"
},
"org_wide": {
"default": "false",
"desc": "When `true`, the channel will be available org-wide. Note: if the channel is not `org_wide=true`, you must specify a `team_id` for this channel",
"example": "true",
"required": false,
"type": "boolean"
},
"team_id": {
"desc": "The workspace to create the channel in. Note: this argument is required unless you set `org_wide=true`.",
"required": false
}
},
"desc": "Create a public or private channel-based conversation.",
"errors": {
"could_not_create_channel": "The channel could not be created.",
"feature_not_enabled": "The token provided doesn't have access to this method.",
"invalid_name": "The value passed for `name` was invalid.",
"invalid_team": "The provided workspace is invalid.",
"name_taken": "A channel cannot be created with the given name.",
"no_local_user_on_team": "The workspace provided had no users.",
"restricted_action": "A workspace preference prevents the authenticated user from creating channels.",
"team_id_or_org_required": "You must provide a `team_id` or set `org_wide` to `true`.",
"team_not_found": "No workspace was found for the `team_id` provided."
},
"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"
}
]
}
}