Skip to main content

Deleting Entities

The Gateway provides an endpoint for deleting entities from the database.

Request

Here is a basic example:

DELETE 

/api/v1/entities/:id

DELETE /api/v1/entities/6798b7b709256629566d21bd

This request deletes the entity with the ID 6798b7b709256629566d21bd. NOTE: Deleted entities are not immediately removed from the database. Instead, they are marked as deleted and will be permanently removed after 30 days from the deletion date. To recover a deleted entity, refer to the Recovering Entities page.

Response

  • If the entity does not exist, the Gateway returns a 404 Not Found error.
  • If the entity is successfully deleted, the Gateway returns a 200 OK response.
  • If the entity was already deleted, the Gateway returns a 304 Not Modified response.