Skip to content
Optiwork API Docs

Rename a world

PATCH
/spaces/maps/{map}
curl --request PATCH \
  --url https://spaces.work.optidata.cloud/api/spaces/maps/a28e5bf3-26b4-4a34-9f98-9a116a2700ca \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "Head office — 2026 layout" }'

Renames a world. Builders only. The name must be unique within the company.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
map
required
string

The world’s identifier.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
>= 1 characters <= 120 characters
Examples
Examplerename
{
  "name": "Head office — 2026 layout"
}

Responses

Section titled “ Responses ”

200

Section titled “200”

The renamed world, without its map document.

Media typeapplication/json
object
identifier
required
string
name
required
string
source_map

The world this one was copied from, if any.

string | null
status
required
string
Allowed values: draft active
is_active
required
boolean
version
required

Grows with every saved change.

integer
activated_at
string | null format: date-time
created_by_uuid
string | null
updated_by_uuid
string | null
created_at
string format: date-time
updated_at
string format: date-time
Examples
Examplerenamed
{
  "identifier": "a305115b-efef-44ed-a2a2-ebc1d8e988e8",
  "name": "Head office — 2026 layout",
  "source_map": null,
  "status": "draft",
  "is_active": false,
  "version": 1,
  "activated_at": null,
  "created_by_uuid": "2d9e8f70-1a3b-4c5d-8e9f-a0b1c2d3e4f5",
  "updated_by_uuid": "2d9e8f70-1a3b-4c5d-8e9f-a0b1c2d3e4f5",
  "created_at": "2026-10-19T11:53:34-03:00",
  "updated_at": "2026-10-19T11:53:57-03:00"
}

401

Section titled “401”

No authentication key was sent.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Examplemissing

No bearer token sent

{
  "error": "JWT passport exception: Missing bearer token in request"
}

403

Section titled “403”

The caller is not allowed to do this (see “Who may do what”), or the authentication key is not recognised (empty message).

Media typeapplication/json
object
message
required
string
Examples

Not the space's owner

{
  "message": "You do not have permission to update this space."
}

404

Section titled “404”

Nothing has this identifier.

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

419

Section titled “419”

The authentication key is expired or not recognised. Get a fresh one and retry.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Exampleexpired
{
  "error": "JWT passport expired: Passport expired"
}

422

Section titled “422”

The body failed validation.

Media typeapplication/json
object
message
required

The first validation message.

string
errors
required

Validation messages keyed by field name.

object
key
additional properties
Array<string>
Examplegenerated
{
  "message": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}