Slack.Web.Conversations.ExternalInvitePermissions (SlackKit v1.0.0-alpha.0)

View Source

Summary

Functions

Upgrade or downgrade Slack Connect channel permissions between 'can post only' and 'can post and invite'.

Functions

set(action, channel, target_team, optional_params \\ %{})

Upgrade or downgrade Slack Connect channel permissions between 'can post only' and 'can post and invite'.

API reference

Rate limit: Tier 2: 20+ per minute
Scopes:

View on docs.slack.dev ↗

Required Params

  • action - Type of action to be taken: upgrade or downgrade Acceptable values: upgrade downgrade ex: upgrade
  • channel - The channel ID to change external invite permissions for ex: C123456
  • target_team - The encoded team ID of the target team. Must be in the specified channel. ex: T726G27TT

Errors the API can return:

  • channel_not_found - Cannot find channel
  • invalid_action - The user did not provid a valid action. Valid actions are 'upgrade' or 'downgrade'.
  • invalid_target_team - The target team provided is not valid for the channel.
  • not_supported - Attempting to upgrade a channel that cannot be upgraded
  • restricted_action - A team preference prevents the user from taking this action.

See the Common Errors guide for errors returned by every Web API method.