Sample - Slack Web API
POST/admin.teams.settings.setDescription

Set a workspace description

Sets the description of a specified workspace. Provide team_id to select the workspace and description for its new description. Authenticate with a token that has the admin.teams:write scope.

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

1 parameter · 2 body fields
tokenstringrequired
Authentication token with the `admin.teams:write` scope.

Workspace description update data.

team_idstringrequired
ID for the workspace to set the description for.
descriptionstringrequired
The new description for the workspace.

2 status codes
200Returns a successful response with `ok` set to true.
okbooleanrequired
Allowed:true
defaultReturns the standard failure response with `ok` set to false.
okbooleanrequired
Allowed:false

Error handling

team_id and description must both be provided in the request body. token must carry the admin.teams:write scope, and team_id must identify the workspace to update.