The Delete API in XperienceHR provides an interface for deleting projects, customers, and employees, along with all associated data, ensuring seamless integration with external systems for data management and cleanup.

This API supports XML & JSON format for structured data exchange and requires authentication via an API key.

By integrating the Delete API, organizations can efficiently manage and remove outdated or unnecessary data, ensuring the system remains clean and up-to-date.

Overview

API Type: REST

Supported Formats: XML

API Key: Generated in the app configuration

Method: *POST *

Delete Functionality

Functionality:

• Delete Project
• Delete Customer
• Delete Employee

The Delete API allows you to remove projects, customers, and employees, along with all linked data, from the system. When deleting a project, all associated data is removed, including:

• Time and attendance records
• All subprojects
• Project roles structure configuration

Special Considerations:

• If a project is assigned to an employee with Exception-based Time Tracking, the system will attempt to assign a different random project to the employee. If no other project exists, the deletion operation will fail, and the project will not be deleted.
• The same logic applies if the project is used as the default project for attendance time clock.

Endpoint

Error Handling

Common errors help in debugging and correcting API usage issues.

Example 1: Client Not Found

HTTP Response Codes

• **2XX Success ** - Operation completed successfully.
• **4XX Client Error ** - Likely an issue with the request, such as incorrect parameters or insufficient permissions. Returns an error message in text or XML format.
• **5XX Server Error ** - Indicates a server issue. Report this error if encountered.

Updated on: 19/03/2025