Delete Data by Location

Delete all data associated with a specific location

POST /v1/organizations/documents/locations/data/delete

Delete Data by Location

cURL

curl --request POST \
  --url https://api.velt.dev/v1/organizations/documents/locations/data/delete \
  --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>",
    "documentId": "<string>",
    "location": {}
  }
}
'

{
  "result": {
    "status": "success",
    "message": "Data deleted successfully.",
    "data": null
  }
}

Use this API to delete all data (comments, recordings, or any other feature data) associated with a specific location.

Endpoint

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

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

documentId · string · required

Document ID

location · object · required

The location object containing the data to be deleted

Example Request

{
  "data": {
    "apiKey": "YOUR_API_KEY",
    "authToken": "YOUR_AUTH_TOKEN",
    "documentId": "YOUR_DOCUMENT_ID",
    "location": {
      "id": "scene_1",
      "locationName": "White scene"
    }
  }
}

Response

Success Response

{
  "result": {
    "status": "success",
    "message": "Data deleted successfully.",
    "data": null
  }
}

Failure Response

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

{
  "result": {
    "status": "success",
    "message": "Data deleted successfully.",
    "data": null
  }
}