Rename a workspace

Changes the workspace display name and returns the updated JSON:API resource. The slug never changes. Requires an admin signed in with a user access token.

Authorization

bearer

AuthorizationBearer <token>

User access token authentication. Every endpoint accepts it, and endpoints that act as a person accept only it. Send a WorkOS access token in the Authorization header as: Bearer <token>.

In: header

Path Parameters

workspace*string

The workspace slug — the {slug} segment of your Clarify workspace URL.

Query Parameters

silent?boolean

When true, suppresses in-app and Slack notifications for this mutation.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

data*

The changes to apply to the workspace.

Response Body

`application/json`

curl -X PATCH "https://example.com/workspaces/string" \  -H "Content-Type: application/json" \  -d '{    "data": {      "type": "workspace",      "attributes": {        "name": "Acme Corporation"      }    }  }'

{  "data": {    "type": "workspace",    "id": "3b9f6c2e-8d1a-4f5e-9c7b-2a4d6e8f0c13",    "attributes": {      "slug": "acme",      "name": "Acme Corporation",      "organization_id": "org_01HXYZACMECORP0000000000",      "created_at": "2026-01-15T09:30:00.000Z"    }  }}