conversations.requestSharedInvite.approve

View other methods

Approves a request to add an external user to a channel and sends them a Slack Connect invite

Reference docs Tester

Notices

This API method can only be used on Enterprise Grid workspaces.

Facts

Method access

HTTP

JavaScript

Python

Java

HTTP

POSThttps://slack-gov.com/api/conversations.requestSharedInvite.approve

Bolt for Java

app.client().conversationsRequestSharedInviteApprove

Bolt for Python

app.client.conversations_requestSharedInvite_approve

Bolt for JavaScript

app.client.conversations.requestSharedInvite.approve

Required scopes

Bot tokensconversations.connect:manageconversations.connect:manage

Content types

application/x-www-form-urlencodedapplication/json

Rate limits

Tier 2

Arguments

Required arguments

token

token

·Required

Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.

Example

xxxx-xxxxxxxxx-xxxx

invite_id

·Required

ID of the requested shared channel invite to approve.

Optional arguments

channel_id

string

·Optional

Optional channel_id to which external user will be invited to. Will override the value on the requested invite.

Example

C1234567890

is_external_limited

boolean

·Optional

Optional boolean on whether the invited team will have post-only permissions in the channel. Will override the value on the requested invite.

Example

true

message

object

·Optional

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}

Usage info

This Slack Connect API method approves a requested Slack Connect invitation. As a result, an email invitation will be sent to an external user. An external user may be added directly to the channel if the external workspace is already connected to the channel. If the channel to be joined is not already a Slack Connect channel, it becomes a Slack Connect channel when this method is used.

Prerequisites

You must have administrator access to a workspace that is part of an Enterprise Grid plan.
You must have the following settings configured within your Admin Dashboard under Slack Connect Settings: a) Toggle on the Apply automation rules before channel invitations are sent preference. b) Under Channels, toggle on either the Sending Invitations with Permission to Post Only or the Sending Invitations with permission to post, invite and more preference.

For more details, refer to governing Slack Connect invites.

Using the `channel_id` argument

The channel_id argument allows the approver to override the channel from which Slack Connect invitations will be sent. The channel must be visible to the user who requested the invitation.

Using the `is_external_limited` argument

The is_external_limited argument allows the approver to override the value on the requested invitation. The user requesting the invitation must have permission to send Slack Connect invitations with the specified value.

Example responses

Common successful response

Typical success response

{
    "ok": true,
    "invite_id": "I012345ABCD"
}

Common error response

Typical error response when invite request can not be approved

{
    "ok": false,
    "error": "restricted_action"
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok params in the response.

Error	Description
`invite_not_found`	We couldn't find a Slack Connect channel invite with the ID provided.
`invite_already_approved`	This invite was already approved.
`invite_already_denied`	This invite was already denied.
`invite_expired`	This invite is expired.
`channel_not_found`	The provided channel was not found or the channel is no longer visible to the user who requested the invite.
`user_not_found`	Can not find the user who requested the invite.
`team_not_found`	Can not find the team who requested the invite.
`restricted_action`	A team preference prevents the invite from being approved.
`no_external_invite_permission`	Channel manager has restricted external invites for a given channel.
`internal_error`	The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.
`message_too_long`	If the passed in approve message is greater than 560 characters.
`access_denied`	Access to a resource specified in the request is denied.
`account_inactive`	Authentication token is for a deleted user or workspace when using a `bot` token.
`deprecated_endpoint`	The endpoint has been deprecated.
`ekm_access_denied`	Administrators have suspended the ability to post a message.
`enterprise_is_restricted`	The method cannot be called from an Enterprise.
`invalid_auth`	Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.
`is_bot`	This method cannot be called by a legacy bot.
`user_is_restricted`	This method cannot be called by a restricted user or single channel guest.
`method_deprecated`	The method has been deprecated.
`missing_scope`	The token used is not granted the specific scope permissions required to complete this request.
`not_allowed_token_type`	The token type used in this request is not allowed.
`not_authed`	No authentication token provided.
`no_permission`	The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.
`org_login_required`	The workspace is undergoing an enterprise migration and will not be available until migration is complete.
`token_expired`	Authentication token has expired
`token_revoked`	Authentication token is for a deleted user or workspace or the app has been removed when using a `user` token.
`two_factor_setup_required`	Two factor setup is required.
`accesslimited`	Access to this method is limited on the current network
`fatal_error`	The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.
`invalid_arg_name`	The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than `_`. If you get this error, it is typically an indication that you have made a very malformed API call.
`invalid_arguments`	The method was either called with invalid arguments or some detail about the arguments passed is invalid, which is more likely when using complex arguments like blocks or attachments.
`invalid_array_arg`	The method was passed an array as an argument. Please only input valid strings.
`invalid_charset`	The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.
`invalid_form_data`	The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.
`invalid_post_type`	The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.
`missing_post_type`	The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.
`ratelimited`	The request has been ratelimited. Refer to the `Retry-After` header for when to retry the request.
`request_timeout`	The method was called via a `POST` request, but the `POST` data was either missing or truncated.
`service_unavailable`	The service is temporarily unavailable
`team_added_to_org`	The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.

Warnings

This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.

Warning	Description
`missing_charset`	The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.
`superfluous_charset`	The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous.

API response

URL

POST body

Submit your arguments to see the API response

conversations.requestSharedInvite.approve

Notices

Facts

Method access

Required scopes

Content types

Rate limits

Arguments

Usage info

Prerequisites

Using the channel_id argument

Using the is_external_limited argument

Example responses

Common successful response

Common error response

Errors

Warnings

Arguments

API response

Using the `channel_id` argument

Using the `is_external_limited` argument