apiDelete

Summary

If you need to delete a item from the data, such as a customer, supplier, sales order, etc then you would use a method called apiDelete.

The apiDelete method allows you to delete a specific item from the backend. Exercise caution when using this method, as it permanently removes the record from the system, and deleted data cannot be recovered. This method is used to ensure data cleanup and removal when necessary, such as deleting obsolete records or managing data retention policies.

apiDelete Parameters

apiDelete Example

"apiDelete": {
  "endpoint": "v1/departments",
  "prefix": "prefix",
  "id": {
    "get": {
      "state": "department_id"
    }
  }
}