POST
/
deletedatabylocation
curl --request POST \
  --url https://api.velt.dev/deletedatabylocation
{
  "result": {
    "status": "success",
    "message": "Data deleted successfully.",
    "data": null
  }
}

Deleting Data by Location

You can delete all data at a specific location using an API call. Data refers to comments, recordings, or any other feature data relating to that location.

To dete all data by location via the API, send a POST request to https://api.velt.dev/deletedatabylocation with the following body data.

Body:

{
    "data": {
        "apiKey": "YOUR_API_KEY",
        "authToken": "YOUR_AUTH_TOKEN",
        "documentId": "YOUR_DOCUMENT_ID",
        "location": YOUR_LOCATION_OBJECT_HERE
    }
}

Not sure where find your Auth Token? You can follow these steps to generate your Auth Token.

Success Response:

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

Failure Response:

{
  "error": {
    "message": "Invalid Api key!",
    "status": "UNAUTHENTICATED"
  }
}

Example

For example, if you want to delete all the data related to the location object with the id of “scene_1” shown below, then you will have to pass below data in body of the post method:

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

Response result

message
string

Status description message for the response

status
string

Status for the response

data
object

Contains data for the response

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