Replace a tag
const url = 'https://example.com/v1/example/data/tags/example';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"id":"example","name":"Reception","keywords":"Reception","icon":"123","highlighted":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://example.com/v1/example/data/tags/example \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "id": "example", "name": "Reception", "keywords": "Reception", "icon": "123", "highlighted": true }'If the body includes an id, it must match the one in the path.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The project ID of the space
The tag’s id
Request Bodyrequired
Section titled “Request Bodyrequired”A category that landmarks can be listed under, e.g. for searching. Only categories with at least one landmark are shown to visitors.
object
Identifies the category. Equal to its key in the space’s tags. Using the id of a built-in category replaces that category for this space.
The category’s name, shown to visitors and used when searching.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
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.
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
Other words visitors might search for to find the category, separated by commas in each language.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
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.
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
The icon shown with the category.
Whether to suggest the category to visitors before they’ve searched, with the distance to the nearest landmark in it.
Responses
Section titled “Responses”The updated tag
A category that landmarks can be listed under, e.g. for searching. Only categories with at least one landmark are shown to visitors.
object
Identifies the category. Equal to its key in the space’s tags. Using the id of a built-in category replaces that category for this space.
The category’s name, shown to visitors and used when searching.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
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.
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
Other words visitors might search for to find the category, separated by commas in each language.
object
The text in the language given by locale. Also shown when there’s no variant for the viewer’s language.
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.
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
The icon shown with the category.
Whether to suggest the category to visitors before they’ve searched, with the distance to the nearest landmark in it.
Example
{ "name": "Reception", "keywords": "Reception", "icon": "123"}The body is invalid. issues describes what was wrong.
object
A description of the error
A stable identifier for the kind of error
For invalidBody: what failed validation, and where
object
Example generated
{ "error": "example", "code": "example", "issues": [ {} ]}The token is missing or invalid.
object
A description of the error
A stable identifier for the kind of error
For invalidBody: what failed validation, and where
object
Example generated
{ "error": "example", "code": "example", "issues": [ {} ]}The token has no access to this space.
object
A description of the error
A stable identifier for the kind of error
For invalidBody: what failed validation, and where
object
Example generated
{ "error": "example", "code": "example", "issues": [ {} ]}No item has this id.
object
A description of the error
A stable identifier for the kind of error
For invalidBody: what failed validation, and where
object
Example generated
{ "error": "example", "code": "example", "issues": [ {} ]}The body isn’t in a format this operation accepts.
object
A description of the error
A stable identifier for the kind of error
For invalidBody: what failed validation, and where
object
Example generated
{ "error": "example", "code": "example", "issues": [ {} ]}Too many requests. Retry after Retry-After seconds.
object
A description of the error
A stable identifier for the kind of error
For invalidBody: what failed validation, and where
object
Example generated
{ "error": "example", "code": "example", "issues": [ {} ]}Headers
Section titled “Headers”Seconds to wait before retrying
Something upstream failed.
object
A description of the error
A stable identifier for the kind of error
For invalidBody: what failed validation, and where
object
Example generated
{ "error": "example", "code": "example", "issues": [ {} ]}The space is moving between servers. Retry after Retry-After seconds.
object
A description of the error
A stable identifier for the kind of error
For invalidBody: what failed validation, and where
object
Example generated
{ "error": "example", "code": "example", "issues": [ {} ]}Headers
Section titled “Headers”Seconds to wait before retrying
Something upstream timed out.
object
A description of the error
A stable identifier for the kind of error
For invalidBody: what failed validation, and where
object
Example generated
{ "error": "example", "code": "example", "issues": [ {} ]}