Rivier/ Reference/ workspace

Workspace org workspace rename

patch/organizations/{id}/workspaces/{wid}

Rename a workspace, or move it to another organisation by giving organizationId (an owner or admin of both; a person signs in for this, a key cannot).

Before you call

Credential
Authorization: Bearer $KEY
Scope
workspace:admin
Graphql
Mutation.workspaceOrgWorkspaceRename
Sdk
workspace.orgWorkspace.rename
Cli
workspace org workspace rename

Parameters

  • idstring (uuid)required
    In the path
  • widstringrequired
    In the path

Request bodyapplication/json, required

  • namestring
    At most 200 characters.
  • organizationIdstring (uuid)

Responses

  • 200application/json
    Success

    object

  • 400application/json
    The request was malformed
    • errorstringrequired
    • messagestring
  • 401application/json
    No valid credential
    • errorstringrequired
    • messagestring
  • 403application/json
    The credential lacks the scope, origin or address
    • errorstringrequired
    • messagestring
  • 429application/json
    Over the key's rate limit; see Retry-After
    • errorstringrequired
    • messagestring

This page as Markdown