Skip to main content

conversations.requestSharedInvite.approve method

Facts​

DescriptionApproves a request to add an external user to a channel and sends them a Slack Connect invite
Method Access
POST https://slack.com/api/conversations.requestSharedInvite.approve
Scopes
Content types
application/x-www-form-urlencoded
application/json
Rate LimitsTier 2: 20+ per minute

Arguments​

Required arguments

tokenstringRequired

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_idRequired

ID of the requested shared channel invite to approve.

Optional arguments

is_external_limitedbooleanOptional

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

channel_idstringOptional

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

messageobjectOptional

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 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.

Response​

Typical success response

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

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 parameter in the response.

Error
Description
access_denied

Access to a resource specified in the request is denied.

accesslimited

Access to this method is limited on the current network

account_inactive

Authentication token is for a deleted user or workspace when using a bot token.

channel_not_found

The provided channel was not found or the channel is no longer visible to the user who requested the invite.

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.

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.

internal_error

Something unexpected went wrong.

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.

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 called with invalid arguments.

invalid_array_arg

The method was passed an array as an argument. Please only input valid strings.

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.

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.

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.

method_deprecated

The method has been deprecated.

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.

missing_scope

The token used is not granted the specific scope permissions required to complete this request.

no_external_invite_permission

Channel manager has restricted external invites for a given channel.

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.

not_allowed_token_type

The token type used in this request is not allowed.

not_authed

No authentication token provided.

org_login_required

The workspace is undergoing an enterprise migration and will not be available until migration is complete.

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.

restricted_action

A team preference prevents the invite from being approved.

service_unavailable

The service is temporarily unavailable

team_access_not_granted

The token used is not granted the specific workspace access required to complete this request.

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.

team_not_found

Can not find the team who requested the invite.

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.

user_not_found

Can not find the user who requested the invite.