New API version v7.8.64 has been released! 🎉
REST Documentation
DELETE Delete Project

Delete Project

This endpoint allows you to permanently delete a project from the system.

Request

DELETE /api/v1/projects/:id
curl --request DELETE \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/projects/123' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}'

Parameters

  • id (integer, required): The ID of the project to delete

Response

Successful Deletion

{
	"message": "Project deleted successfully"
}

A successful deletion returns a success message.

Error Codes

  • 401 Unauthorized: Invalid or missing authentication
  • 404 Not Found: Project with the specified ID was not found
  • 500 Internal Server Error: Project could not be deleted. This may occur if the project has related records that prevent deletion.

Notes

  • Deleting a project is a permanent action and cannot be undone
  • A project may not be deletable if related records exist, such as:
    • Project time entries (Attendances)
    • Project tasks (Tasks)
    • Project employee assignments
    • Invoices
    • Quotes
  • Make sure you use the correct project ID before executing the deletion
  • Verify that the user has the necessary permissions to delete projects
  • In many cases, it is preferable to change the project status or archive the project rather than deleting it

Example

DELETE /api/v1/projects/123

Response on Success:

{
	"message": "Project deleted successfully"
}

Response on Error (500):

{
	"message": "Project could not be deleted"
}