Sample - Slack Web API
POST/admin.conversations.restrictAccess.addGroup

Allow an identity-provider group in a channel

Adds an identity-provider group to the allowlist for a private channel. Supply group_id and channel_id in the form-encoded request body, and include team_id when the channel is tied to one workspace. The group controls which users can access the channel.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

4 body fields

Form-encoded details for adding an identity-provider group to a private channel allowlist.

tokenstringrequired
Authentication token. Requires scope: `admin.conversations:write`
team_idstringoptional
The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.
group_idstringrequired
The [IDP Group](https://slack.com/help/articles/115001435788-Connect-identity-provider-groups-to-your-Enterprise-Grid-org) ID to be an allowlist for the private channel.
channel_idstringrequired
The channel to link this group to.

2 status codes
200Returns a successful response containing the `ok` flag after linking the identity-provider group.
okbooleanrequired
Allowed:true
defaultReturned when the group cannot be added successfully; the response contains `ok: false`.
okbooleanrequired
Allowed:false

Error handling

token must provide the admin.conversations:write scope, and the body must include group_id and channel_id. Include team_id when the channel is tied to only one workspace; omit it only for channels shared across an organization.