Update Location

Update a Location’s metadata

POST /v1/organizations/documents/locations/update

Update Location

cURL

curl --request POST \
  --url https://api.velt.dev/v1/organizations/documents/locations/update \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <x-velt-api-key>' \
  --header 'x-velt-auth-token: <x-velt-auth-token>' \
  --data '
{
  "data": {
    "apiKey": "<string>",
    "authToken": "<string>",
    "organizationId": "<string>",
    "documentId": "<string>",
    "migrate": {
      "oldLocation": {},
      "newLocation": {}
    },
    "merge": true
  }
}
'

{
  "result": {
    "status": "success",
    "message": "Location updated.",
    "data": null
  }
}

Use this API to update a Location’s metadata.

Endpoint

POST https://api.velt.dev/v1/organizations/documents/locations/update

Headers

x-velt-api-key · string · required

Your API key.

x-velt-auth-token · string · required

Your Auth Token.

Body

Params

data · object · required

Show properties

apiKey · string · required

Your API key

authToken · string · required

Your Auth Token

organizationId · string

Organization ID. Provide the organizationId if you are using Organizations feature.

documentId · string · required

Document ID

migrate · object · required

Show properties

oldLocation · object · required

The current location object

newLocation · object · required

The updated location object

merge · boolean

When true, merges new location fields with existing ones. When false, completely replaces the old location object. Default: false

Example Request

{
  "data": {
    "apiKey": "YOUR_API_KEY",
    "authToken": "YOUR_AUTH_TOKEN",
    "documentId": "YOUR_DOCUMENT_ID",
    "migrate": {
      "oldLocation": {
        "id": "scene_1",
        "locationName": "Untitled scene"
      },
      "newLocation": {
        "id": "scene_1",
        "locationName": "White scene"
      }
    },
    "merge": true
  }
}

Response

Success Response

{
  "result": {
    "status": "success",
    "message": "Location updated.",
    "data": null
  }
}

Failure Response

{
  "error": {
    "message": "ERROR_MESSAGE",
    "status": "INVALID_ARGUMENT"
  }
}

{
  "result": {
    "status": "success",
    "message": "Location updated.",
    "data": null
  }
}