Update workspace

Updates workspace metadata (name, slug) for the selected workspace.

PATCH /workspaces/{id}

Update workspace

cURL

curl --request PATCH \
  --url https://api.akua.dev/v1/workspaces/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'if-match: <if-match>' \
  --data '
{
  "name": "<string>",
  "slug": "<string>"
}
'

200

{
  "id": "ws_j572abc123def456",
  "name": "Acme Research",
  "slug": "<string>",
  "plan": {
    "tier": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": 1,
  "etag": "<string>"
}

Authorizations

Authorization · string · header · required

workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens

Headers

akua-context · string

Optional workspace/scope context for the request. Carries a single workspace wire id (ws_…) today. Only needed for broad tokens — a workspace-owned token implies its workspace.

Required string length: 1 - 53

Example:

"ws_j572abc123def456"

if-match · string · required

The etag of the resource version the client last read. Required on writes when the resource exposes an etag field. Mismatch returns 409 ABORTED with the current etag in the error metadata.

Required string length: 1 - 256

Example:

"42"

Path Parameters

id · string · required

Workspace ID

Required string length: 1 - 53

Body

application/json

name · string

Required string length: 1 - 100

slug · string

Required string length: 3 - 39

Response

200

application/json

Workspace updated

id · string · required

Workspace ID

Required string length: 1 - 53

Example:

"ws_j572abc123def456"

name · string · required

Display name

Example:

"Acme Research"

slug · string · required

URL-safe workspace slug

plan · object · required

Show child attributes

created_at · string<date-time> · required

Workspace created timestamp

updated_at · integer · required

Unix timestamp (seconds)

Required range: x >= 0

etag · string · required