Update a cloud anchor

patch

https://platform.reactvision.xyz/functions/v1/cloud-anchors/{anchor_id}

Secret key only.

Changes an anchor's name, description, tags, metadata, privacy or mesh. The response is the whole anchor, including keypoints_json and associations_json.

An id your key cannot reach (another team's, or another project's for a bound key) gets the same answer as an id that does not exist.

Counts as one request against the team's monthly API request quota, including a request that then fails a check.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

`INVALID_BODY`: the body is not valid JSON, or not a JSON object.

`INVALID_FIELD_VALUE`: `tags`, `metadata` or `is_public` was sent as `null`, or a field has the wrong type.

`FIELD_TOO_LONG`: `name` or `description` is over its limit, or `metadata` is over 4096 bytes.

`INVALID_MESH_URL`: `mesh_url` is not a mesh file of the anchor's project.

`NO_UPDATES`: no field this operation can change was sent.

`MISSING_API_KEY`: no `x-api-key` header.

`INVALID_API_KEY_FORMAT`: the key is not `rv_live_`, `rv_client_` or `rv_secret_` followed by 64 lowercase hexadecimal characters.

`INVALID_API_KEY`: no such key, or a key sent with the wrong prefix for its type.

`API_KEY_EXPIRED`: the key is past its expiry date.

`AUTH_ERROR`: a user token (`rv_ut_`) was sent as a Bearer token. This operation does not accept user tokens.

`API_KEY_TYPE_NOT_ALLOWED`: a client key. This operation needs a secret key.

`API_REQUEST_LIMIT_REACHED`: the team's monthly API request quota is used up.

`ANCHOR_NOT_FOUND`: no such anchor, or one the key cannot reach.

`RATE_LIMITED`: more than 600 a minute from one IP address; or, for a secret key, more than 1,200 requests a minute across all operations. Wait the number of seconds in `Retry-After`. See Limits.

`UPDATE_FAILED`: the change could not be stored.

`INTERNAL_ERROR`: an unexpected error. Retry, and quote `meta.request_id` to support if it persists.

`API_KEY_LOOKUP_FAILED`: the key could not be checked. Retry; this does not mean the key is invalid.

`PROJECT_LOOKUP_FAILED`: the project could not be checked. Retry.

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

200The updated anchor.

403API_KEY_TYPE_NOT_ALLOWED: a client key. This operation needs a secret key. API_REQUEST_LIMIT_REACHED: the team's monthly API request quota is used up.

404ANCHOR_NOT_FOUND: no such anchor, or one the key cannot reach.

429RATE_LIMITED: more than 600 a minute from one IP address; or, for a secret key, more than 1,200 requests a minute across all operations. Wait the number of seconds in Retry-After. See Limits.

500UPDATE_FAILED: the change could not be stored. INTERNAL_ERROR: an unexpected error. Retry, and quote meta.request_id to support if it persists.

503API_KEY_LOOKUP_FAILED: the key could not be checked. Retry; this does not mean the key is invalid. PROJECT_LOOKUP_FAILED: the project could not be checked. Retry.

`API_KEY_TYPE_NOT_ALLOWED`: a client key. This operation needs a secret key.

`API_REQUEST_LIMIT_REACHED`: the team's monthly API request quota is used up.

`ANCHOR_NOT_FOUND`: no such anchor, or one the key cannot reach.

`RATE_LIMITED`: more than 600 a minute from one IP address; or, for a secret key, more than 1,200 requests a minute across all operations. Wait the number of seconds in `Retry-After`. See Limits.

`UPDATE_FAILED`: the change could not be stored.

`INTERNAL_ERROR`: an unexpected error. Retry, and quote `meta.request_id` to support if it persists.

`API_KEY_LOOKUP_FAILED`: the key could not be checked. Retry; this does not mean the key is invalid.

`PROJECT_LOOKUP_FAILED`: the project could not be checked. Retry.