Skip to main content

Delete User

Delete an existing user and their associated workspace from your enterprise account. This endpoint allows enterprise administrators to remove user accounts when needed.

API Endpoint​

POST enterprise/delete-user

Authentication​

This endpoint requires Enterprise API key authentication. Include your API key in the request headers:

sivi-api-key: YOUR_ENTERPRISE_API_KEY
Enterprise Admin Access Required

This endpoint can only be accessed using an Enterprise Admin API key. Regular API keys do not have sufficient privileges.

Request Body​

{
  "abstractUserId": "281743-2322-34i44sd3-dkfjgdkjf292"
}

Request Parameters​

ParameterTypeRequiredDescription
abstractUserIdstringYesUnique identifier for the user to delete

Response​

Successful Deletion​

{
  "status": 200,
  "body": {
    "message": "Successfully deleted the user"
  }
}

User Not Found​

{
  "status": 400,
  "body": {
    "message": "User does not exists"
  }
}

Authentication Error​

{
  "status": 401,
  "body": {
    "message": "Failed to authenticate request. Please add sivi-api-key header in request"
  }
}

Invalid Input​

{
  "status": 422,
  "body": {
    "message": "Invalid input"
  }
}

Usage Notes​

  • This operation permanently deletes a user and their workspace
  • All designs, content, and settings associated with the user will be irreversibly removed
  • This action cannot be undone
  • If the user doesn't exist in Sivi's system, the operation will fail with a 400 status code
warning

User deletion is permanent. Data is maintained for 15 days and post that data is purged

Example​

curl -X POST "https://connect.sivi.ai/api/prod/v2/enterprise/delete-user" \
  -H "sivi-api-key: YOUR_ENTERPRISE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "abstractUserId": "user-12345"
}'

User Deletion Flow​

The following flowchart illustrates the user deletion process:

  • Login User - Create a new user or login an existing user