Skip to content

Replace the space's name, subtitle and type

PUT
/{resource}/data
curl --request PUT \
--url https://example.com/v1/example/data \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "Reception", "subtitle": "Reception", "type": "residential", "address": { "address": "1 Example Street", "unit": "Suite 400", "locality": "London", "province": "GB-ENG", "country": "GB", "postalCode": "SW1A 1AA" }, "georeference": { "latitude": 51.5072, "longitude": -0.1276, "heading": 90 } }'

Fields left out are removed. Only name, subtitle and type can be given - the rest of the space is written through its own paths.

resource
required
string
/^\d+$/

The project ID of the space

Media typeapplication/json

A space’s name, subtitle, type, address and georeference.

object
name

The space’s name, shown to visitors as its heading.

object
value
required

The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.

string
locale
required

The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.

string
variants

Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.

object
key
additional properties
string
subtitle

A second line shown under the name.

object
value
required

The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.

string
locale
required

The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.

string
variants

Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.

object
key
additional properties
string
type

What kind of space it is. Decides which built-in landmark categories are suggested to editors.

string
Allowed values: residential office retail public industrial healthcare
address

The space’s postal address.

object
address
required

The street address, without any unit or suite.

string
>= 1 characters
unit

The unit or suite, if any.

string
locality
required

The town or city.

string
>= 1 characters
province

The state, province or region, as an ISO 3166-2 code. Should be given wherever the country has them.

string
/^[A-Z]{2}-[A-Z0-9]{1,3}$/
country
required

The country, as an ISO 3166-1 alpha-2 code.

string
/^[A-Z]{2}$/
postalCode

The postal code.

string
georeference

Where the space is in the world. Needed to export the space in other formats, such as IMDF.

object
latitude
required

The WGS 84 latitude, in degrees, of the space’s origin [0, 0, 0].

number
>= -90 <= 90
longitude
required

The WGS 84 longitude, in degrees, of the space’s origin [0, 0, 0].

number
>= -180 <= 180
heading
required

The compass bearing that the space’s -z axis points along, in degrees clockwise from true north. At 0, -z points north and +x points east.

number
< 360
altitude

The height of the space’s origin above the WGS 84 ellipsoid, in metres.

number

The updated space’s name, subtitle and type

Media typeapplication/json

A space’s name, subtitle, type, address and georeference.

object
name

The space’s name, shown to visitors as its heading.

object
value
required

The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.

string
locale
required

The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.

string
variants

Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.

object
key
additional properties
string
subtitle

A second line shown under the name.

object
value
required

The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.

string
locale
required

The language value is written in, as a BCP 47 tag - a base language such as en, or a regional one such as en-GB.

string
variants

Translations of value, keyed by BCP 47 language tag. A viewer sees the variant for their exact language (e.g. en-GB), then the one for its base language (e.g. en), then value.

object
key
additional properties
string
type

What kind of space it is. Decides which built-in landmark categories are suggested to editors.

string
Allowed values: residential office retail public industrial healthcare
address

The space’s postal address.

object
address
required

The street address, without any unit or suite.

string
>= 1 characters
unit

The unit or suite, if any.

string
locality
required

The town or city.

string
>= 1 characters
province

The state, province or region, as an ISO 3166-2 code. Should be given wherever the country has them.

string
/^[A-Z]{2}-[A-Z0-9]{1,3}$/
country
required

The country, as an ISO 3166-1 alpha-2 code.

string
/^[A-Z]{2}$/
postalCode

The postal code.

string
georeference

Where the space is in the world. Needed to export the space in other formats, such as IMDF.

object
latitude
required

The WGS 84 latitude, in degrees, of the space’s origin [0, 0, 0].

number
>= -90 <= 90
longitude
required

The WGS 84 longitude, in degrees, of the space’s origin [0, 0, 0].

number
>= -180 <= 180
heading
required

The compass bearing that the space’s -z axis points along, in degrees clockwise from true north. At 0, -z points north and +x points east.

number
< 360
altitude

The height of the space’s origin above the WGS 84 ellipsoid, in metres.

number

Example

{
"name": "Reception",
"subtitle": "Reception",
"type": "residential",
"address": {
"address": "1 Example Street",
"unit": "Suite 400",
"locality": "London",
"province": "GB-ENG",
"country": "GB",
"postalCode": "SW1A 1AA"
},
"georeference": {
"latitude": 51.5072,
"longitude": -0.1276,
"heading": 90
}
}

The body is invalid. issues describes what was wrong.

Media typeapplication/json
object
error
required

A description of the error

string
code
required

A stable identifier for the kind of error

string
issues

For invalidBody: what failed validation, and where

Array<object>
object

Example generated

{
"error": "example",
"code": "example",
"issues": [
{}
]
}

The token is missing or invalid.

Media typeapplication/json
object
error
required

A description of the error

string
code
required

A stable identifier for the kind of error

string
issues

For invalidBody: what failed validation, and where

Array<object>
object

Example generated

{
"error": "example",
"code": "example",
"issues": [
{}
]
}

The token has no access to this space.

Media typeapplication/json
object
error
required

A description of the error

string
code
required

A stable identifier for the kind of error

string
issues

For invalidBody: what failed validation, and where

Array<object>
object

Example generated

{
"error": "example",
"code": "example",
"issues": [
{}
]
}

The body isn’t in a format this operation accepts.

Media typeapplication/json
object
error
required

A description of the error

string
code
required

A stable identifier for the kind of error

string
issues

For invalidBody: what failed validation, and where

Array<object>
object

Example generated

{
"error": "example",
"code": "example",
"issues": [
{}
]
}

Too many requests. Retry after Retry-After seconds.

Media typeapplication/json
object
error
required

A description of the error

string
code
required

A stable identifier for the kind of error

string
issues

For invalidBody: what failed validation, and where

Array<object>
object

Example generated

{
"error": "example",
"code": "example",
"issues": [
{}
]
}
Retry-After
integer

Seconds to wait before retrying

Something upstream failed.

Media typeapplication/json
object
error
required

A description of the error

string
code
required

A stable identifier for the kind of error

string
issues

For invalidBody: what failed validation, and where

Array<object>
object

Example generated

{
"error": "example",
"code": "example",
"issues": [
{}
]
}

The space is moving between servers. Retry after Retry-After seconds.

Media typeapplication/json
object
error
required

A description of the error

string
code
required

A stable identifier for the kind of error

string
issues

For invalidBody: what failed validation, and where

Array<object>
object

Example generated

{
"error": "example",
"code": "example",
"issues": [
{}
]
}
Retry-After
integer

Seconds to wait before retrying

Something upstream timed out.

Media typeapplication/json
object
error
required

A description of the error

string
code
required

A stable identifier for the kind of error

string
issues

For invalidBody: what failed validation, and where

Array<object>
object

Example generated

{
"error": "example",
"code": "example",
"issues": [
{}
]
}