Skip to content

API Reference / Workspaces

Update a workspace

Updates the caller's active workspace's name or description. The target is always the workspace resolved from the caller's session or API key, never a request field, so a caller can never name a different workspace to update. Only the fields you supply are changed.

POST/accounts.v1.Accounts/UpdateWorkspace

Request body

application/jsonRequired

Request to update the caller's current workspace. Fields left out are unchanged.

description?string

New workspace description. Omit to leave unchanged.

name?string

New workspace name. Omit to leave unchanged.

Response body

application/json

Success

workspace?Workspace

The workspace with the update applied.

Show attributes
createdAt?string

When the workspace was created.

Format"date-time"

deletedAt?string

When the workspace was soft-deleted. Unset for active workspaces.

Format"date-time"

description?string

Free-form workspace description set by the workspace owner.

getStartedCompletedAt?string

When the workspace completed Get started: the first time it had proxies, accounts, a connected market and a contract all at once. Unset until then. Once set it is never cleared.

Format"date-time"

hardDeleteAt?string

When a soft-deleted workspace and everything in it is removed permanently. Unset for active workspaces.

Format"date-time"

id?string

Opaque 16-byte workspace identifier, base64-encoded in JSON.

Format"byte" base64

memberCount?integer

Number of accepted memberships in the workspace, computed server-side at read time. Read-only: any value sent by a client is ignored.

Format"int32"

name?string

Human-readable workspace name.

owner?ActorSummary

The workspace owner resolved for display at read time. Set only on administrator reads. Unset when the workspace has no accepted owner.

Show attributes
avatarUrl?string

The user's avatar image URL. Unset for an API key or a user with no avatar.

displayName?string

The user's name or the API key's name at read time. Empty when the actor no longer exists.

id?string

Opaque 16-byte identifier of the user or API key, base64-encoded in JSON.

Format"byte" base64

subjectType?string

How the actor authenticated: a user session or an API key.

Value in"SUBJECT_TYPE_SESSION""SUBJECT_TYPE_API_KEY""SUBJECT_TYPE_SERVICE"

ownerEmail?string

The workspace owner's email. Set only on administrator reads.

updatedAt?string

When the workspace was last modified.

Format"date-time"

curl -X POST "https://api.goldmine.to/accounts.v1.Accounts/UpdateWorkspace" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Primary trading and inventory workspace."
  }'
{
  "workspace": {
    "id": "AAECAwQFBgcICQoLDA0ODw==",
    "name": "Acme Trading",
    "description": "Primary trading and inventory workspace.",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-06-29T12:05:00Z"
  }
}