This section provides information about the /en/developers/api-user-delete
endpoint, which is used to delete a user from the system.
Purpose
The /en/developers/api-user-delete
endpoint allows developers to remove a user from the system. This is typically used for situations where a user has been deactivated or is no longer a part of the organization.
Usage
To delete a user, you need to send a DELETE request to the /en/developers/api-user-delete
endpoint. The request should include the user ID in the URL path.
DELETE /en/developers/api-user-delete/<user-id>
Request Parameters
- User ID: The unique identifier for the user to be deleted. This is required and must be included in the URL path.
Response
On successful deletion, the server will return a 200 OK response. If the user could not be found or another error occurs, the server will return an appropriate error code and message.
Example
Here is an example of a successful DELETE request using curl
:
curl -X DELETE "https://example.com/en/developers/api-user-delete/12345"
Safety and Compliance
When using this endpoint, ensure that you comply with all relevant data protection and privacy laws. Only delete users for legitimate reasons and always verify the identity of the user before deletion.
For more information on data protection and privacy, please refer to our Data Security Policy.
Support
If you encounter any issues or have questions about the /en/developers/api-user-delete
endpoint, please contact our support team at support@example.com.