Update Workspace
Update workspace metadata. **Admin permission required.** Fields not present are left unchanged. Slug is immutable — renaming only changes the display name.
PATCH
/api/v1/workspaces/{id}Authorization
apiKey X-API-Key<token>
Your SteelEngine API key (personal or workspace). Generate one from the SteelEngine dashboard under Settings > API Keys.
In: header
Path Parameters
id*string
Workspace ID.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X PATCH "https://example.com/api/v1/workspaces/string" \ -H "Content-Type: application/json" \ -d '{ "name": "Engineering (renamed)", "color": "#FF0000" }'{ "success": true, "data": { "workspace": { "id": "string", "name": "string", "slug": "string", "color": "string", "ownerId": "string", "organizationId": "string", "billedAccountUserId": "string", "allowPersonalApiKeys": true, "role": "admin", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "archivedAt": "2019-08-24T14:15:22Z" } }}