Delete a funnel

Delete a conversion funnel with the Clics TypeScript SDK when a multistep journey is no longer needed.

Removes a funnel from a project. Drop-off analysis for that funnel stops immediately.

Use when deprecating a user journey, cleaning up test funnels, or syncing definitions from an external source of truth.

Parameters

Signature

clics.funnels.deleteFunnel(request, options?)

Example

import { Clics } from "@clicsdev/sdk";

const clics = new Clics({
  apiKey: process.env.CLICS_API_KEY!,
});

const result = await clics.funnels.deleteFunnel({
  funnelId: "funnel_xxx",
});

console.log(result.deleted);

What it returns

Notes

• Deleting a funnel does not delete underlying pageview or event data: only the funnel definition
• Cannot delete funnels on projects with status: "deleting"

API reference

See Delete a funnel for request and response schemas, status codes, and error types.