Current section
Files
Jump to
Current section
Files
priv/docs/methods/conversations.inviteShared.json
{
"args": {
"channel": {
"desc": "ID of the channel on your team that you'd like to share",
"required": true,
"type": "string"
},
"emails": {
"desc": "Optional email to receive this invite. Either `emails` or `user_ids` must be provided. Only one email or one user ID may be invited at a time.",
"required": false,
"type": "array"
},
"external_limited": {
"desc": "Optional boolean on whether invite is to an external limited member. Defaults to `true`.",
"required": false,
"type": "boolean"
},
"user_ids": {
"desc": "Optional user\\_id to receive this invite. Either `emails` or `user_ids` must be provided. Only one email or one user ID may be invited at a time.",
"required": false,
"type": "array"
}
},
"desc": "Sends an invitation to a Slack Connect channel",
"errors": {
"already_in_channel": "User is already in the channel.",
"cannot_share_cross_workspace_channel": "You cannot share a cross-workspace or org-wide channel.",
"cannot_share_mandatory_channel": "You cannot share #general or mandatory channels.",
"channel_archived": "You cannot share an archived channel.",
"channel_not_found": "The channel provided was not found.",
"connection_limit_exceeded": "This channel has hit the limit of external connections.",
"connection_limit_exceeded_pending": "This channel already has a pending invite.",
"invalid_channel_type": "You cannot share MPDMs or DMs.",
"invalid_email": "At least one email address provided is invalid.",
"invite_lookup_error": "An error occurred while attempting to look for existing invites.",
"invite_not_found": "An error occurred while inviting users.",
"legacy_connection_limit_exceeded": "You cannot share a legacy ESC channel with a third team",
"member_limit_exceeded": "This channel that has hit the limit of members",
"message_too_long": "The provided message was longer than 560 characters.",
"no_external_invite_permission": "User does not have permission to invite an external user.",
"not_allowed_for_grid_workspace": "This workspace does not have Slack Connect enabled.",
"not_in_channel": "The app is not a member of the channel to invite.",
"not_owner": "Only the host organization for a channel can request to share it.",
"not_paid": "This feature is only available to paid teams.",
"not_supported": "This channel cannot be shared.",
"ratelimit": "The rate-limit for this method has been reached. The ratelimit is applied on a per-user basis when you pass the `emails` parameter.",
"recipients_not_specified": "Bots are required to specify which users to invite.",
"restricted_action": "A team preference does not allow this authorization to send invites.",
"too_many_emails": "Too many email recipients were passed in the `emails` parameter.",
"url_in_message": "The message contained a URL.",
"user_not_found": "User lookup failed."
},
"rate_limit": {
"label": "Tier 2: 20+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"bot": [
{
"name": "conversations.connect:write",
"url": "https://docs.slack.dev/reference/scopes/conversations.connect.write"
}
]
}
}