Delete Custom Insight

DELETE

https://platform-api.convirza.com/v3/custom-insights/{id}

Custom Insights

Last modified:2026-07-24 13:10:44

Soft deletes a custom insight by setting status to deleted.

Behavior:

Sets status to deleted instead of removing from database.

Sets deleted_at timestamp and deleted_by user.

Cannot delete system default insights (is_system_default = true).

Associated rules remain in database but insight is hidden from queries.

Scoped to authenticated user organization.

Response:

Returns success message.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

🟢200

application/json

Custom insight deleted successfully

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff --request DELETE 'https://platform-api.convirza.com/v3/custom-insights/{id}' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "success": true,
    "message": "Custom insight deleted successfully"
}

Modified at 2026-07-24 13:10:44