Skip to main content
DELETE
Delete a user

Overview

Permanently deletes a user identified by their project_user_id. This action is irreversible and will remove the user and all associated data from your project.

Authentication

This endpoint requires authentication via the following HTTP headers:
  • X-Clix-Project-ID: Your project ID
  • X-Clix-API-Key: Your Clix Secret API Key

Path Parameters

Example Request

No request body is required for this endpoint.

Response

Success Response (200 OK)

Returns an empty response indicating successful deletion:

Error Responses

400 Bad Request

Returned when:
  • project_user_id is missing or invalid
Returns a plain text error message:

401 Unauthorized

Authentication failed or invalid API key.

Notes

  • This operation is irreversible - deleted users cannot be recovered
  • All user data including properties, devices, and event history will be permanently removed
  • If you need to temporarily disable a user, consider updating their properties instead of deleting
  • After deletion, the same project_user_id can be reused to create a new user
  • Associated devices will also be removed when the user is deleted
  • The endpoint does not return a 404 error - it returns 200 OK even if the user doesn’t exist

Authorizations

X-Clix-Project-ID
string
header
required

Project ID for authentication

X-Clix-API-Key
string
header
required

API Key for authentication

Path Parameters

project_user_id
string
required

The unique identifier of the user to delete

Response

User deleted successfully

Empty response