Slack Web API

/admin.teams.settings.setDescription

POST

admin.teams.settingsadmin

Set the description of a given workspace.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://slack.com/api/admin.teams.settings.setDescription' \
--header 'token;' \
--data-urlencode 'description=' \
--data-urlencode 'team_id='

Response Example

200 - response

{
  "ok": true
}

Request

Header Params

token

string

required

Authentication token. Requires scope: admin.teams:write

Body Params application/x-www-form-urlencoded

description

string

required

The new description for the workspace.

team_id

string

required

ID for the workspace to set the description for.

Responses

🟢200Typical success response

application/json

Body

This method either only returns a brief _OK_ response or a verbose schema is not available for this method.

enum<boolean>

required

Allowed value:

true

Additional properties

integer | number | string | boolean

optional

🔴500Typical error response

Modified at 2023-08-15 05:39:45

/admin.teams.settings.setDefaultChannels

/admin.teams.settings.setDiscoverability