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

Set a workspace name

Sets the name of a workspace. Provide team_id and the new value in name, and authenticate with a token that has permission to modify workspace settings. The operation returns a brief success response when the name is updated.

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

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

Workspace name settings submitted as form data.

team_idstringrequired
ID for the workspace to set the name for.
namestringrequired
The new name of the workspace.

2 status codes
200Returns an object with `ok` set to true when the workspace name is updated.
okbooleanrequired
Allowed:true
defaultReturns an object with `ok` set to false when the request cannot be completed.
okbooleanrequired
Allowed:false

Error handling

The request must include team_id and name in addition to the token header. token must have the admin.teams:write scope, and name must contain the new workspace name.