Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

Jump to
slack_kit priv docs methods admin.conversations.setConversationPrefs.json
Raw

priv/docs/methods/admin.conversations.setConversationPrefs.json

{
"args": {
"channel_id": {
"desc": "The channel to set the prefs for",
"example": "C1234",
"required": true,
"type": "string"
},
"prefs": {
"desc": "The prefs for this channel in a stringified JSON format.",
"example": "{'who_can_post':'type:admin,user:U1234'}",
"required": true,
"type": "string"
}
},
"desc": "Set the posting permissions for a public or private channel.",
"errors": {
"channel_mention_sync_required": "If setting channel mention restriction prefs, both mention prefs must be passed and they must be the same value.",
"channel_not_found": "Value passed for `channel` was invalid.",
"channel_type_not_supported": "Value given for `channel_id` was a #general channel.",
"could_not_set_channel_pref": "Setting the preference or permission failed.",
"default_org_wide_channel": "Returned when you try to modify a default org wide channel.",
"feature_not_enabled": "The Admin APIs feature is not enabled for this team.",
"invalid_value": "Value passed for the preferences are invalid",
"not_an_admin": "The token provided is not associated with an org admin.",
"restricted_action": "A workspace preference prevents the authenticated user from archiving."
},
"rate_limit": {
"label": "Tier 3: 50+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"user": [
{
"name": "admin.conversations:write",
"url": "https://docs.slack.dev/reference/scopes/admin.conversations.write"
}
]
}
}