POST
/
v1
/
organizations
/
documents
/
locations
/
update

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 Example

​
Params

​
data
object
required

​
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"
  }
}

Was this page helpful?

Update Disabled State for DocumentsDelete Data by Location