Current section
Files
Jump to
Current section
Files
priv/docs/methods/conversations.requestSharedInvite.approve.json
{
"args": {
"channel_id": {
"desc": "Optional channel\\_id to which external user will be invited to. Will override the value on the requested invite.",
"required": false,
"type": "string"
},
"invite_id": {
"desc": "ID of the requested shared channel invite to approve.",
"required": true
},
"is_external_limited": {
"desc": "Optional boolean on whether the invited team will have post-only permissions in the channel. Will override the value on the requested invite.",
"required": false,
"type": "boolean"
},
"message": {
"desc": "Object describing the text to send along with the invite. If this object is specified, both `text` and `is_override` are required properties. If `is_override` is set to `true`, `text` will override the original invitation message. Otherwise, `text` will be appended to the original invitation message. The total length of the message cannot exceed 560 characters. If `is_override` is set to `false`, the length of `text` and the user specified message on the invite request in total must be less than 560 characters.",
"example": "{\"text\": \"hello\", \"is_override\": true}",
"required": false,
"type": "object"
}
},
"desc": "Approves a request to add an external user to a channel and sends them a Slack Connect invite",
"errors": {
"channel_not_found": "The provided channel was not found or the channel is no longer visible to the user who requested the invite.",
"invite_already_approved": "This invite was already approved.",
"invite_already_denied": "This invite was already denied.",
"invite_expired": "This invite is expired.",
"invite_not_found": "We couldn't find a Slack Connect channel invite with the ID provided.",
"message_too_long": "If the passed in approve message is greater than 560 characters.",
"no_external_invite_permission": "Channel manager has restricted external invites for a given channel.",
"restricted_action": "A team preference prevents the invite from being approved.",
"team_not_found": "Can not find the team who requested the invite.",
"user_not_found": "Can not find the user who requested the invite."
},
"rate_limit": {
"label": "Tier 2: 20+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"bot": [
{
"name": "conversations.connect:manage",
"url": "https://docs.slack.dev/reference/scopes/conversations.connect.manage"
}
]
}
}