Update funnel

PUT https://datafa.st/api/v1/admin/websites/{websiteId}/funnels/{funnelId}

Update a funnel name, steps, or active state. Set isActive: false to soft-delete (hide) a funnel without removing historical data.

Replacing steps requires the same shape as create funnel (2 to 8 steps).

Related: Conversion funnels · Funnel analytics

Request

Path parameters

websiteId

string

Website ObjectId. From List websites (_id field). Example: 665f0b3c4d2e1a0012345678.

funnelId

string

Funnel ObjectId from List funnels.

Body parameters

name

string

Human-readable name for the resource or event. The exact meaning depends on the endpoint.

steps

object[]

Replace all steps (2–8). Same shape as Create funnel.

isActive

boolean

false to hide the funnel; true to reactivate.

Example request body

{
  "name": "Signup funnel",
  "steps": [
    { "name": "Landing", "type": "pageview", "url": "/" },
    { "name": "Pricing", "type": "pageview", "url": "/pricing" },
    { "name": "Signup", "type": "goal", "goalName": "signup" }
  ]
}

Response

Returns a JSON object with status: "success" and endpoint-specific fields in data.

Response fields

data[]._id

string

Funnel ObjectId.

data[].websiteId

string

Website ObjectId used by account tokens to choose which website to query or manage.

data[].name

string

Human-readable name for the resource or event. The exact meaning depends on the endpoint.

data[].slug

string

Generated slug.

data[].steps

object[]

Ordered funnel steps.

data[].isActive

boolean

Whether the funnel is active.

Authentication

Use a dft_ account token with funnels:write.

A df_ website API key for the same website can also call this route when the path websiteId matches the key's website. Write access with a df_ key is capped at member level — owner-only actions such as team management require a dft_ token and owner role.

Errors

400 — Invalid steps or funnel ID.

404 — Funnel not found.

See API errors for the standard error envelope, auth failures, validation errors, permission errors, and rate limits.

✍️ Something missing? Suggest features.

🤖 AI agent or LLM? Read this page as markdown

curl -X PUT "https://datafa.st/api/v1/admin/websites/{websiteId}/funnels/{funnelId}" \ -H "Authorization: Bearer dft_xxx" \ -H "Content-Type: application/json" \ -d '{"name":"Updated funnel","isActive":true}'

{ "status": "success", "data": [{ "_id": "665f0b3c4d2e1a0012345678", "websiteId": "665f0b3c4d2e1a0012345678", "name": "Signup funnel", "slug": "signup-funnel", "steps": [ { "id": "landing", "name": "Landing", "type": "pageview", "url": "/" }, { "id": "signup", "name": "Signup", "type": "goal", "goalName": "signup" } ], "isActive": true, "createdAt": "2026-05-21T00:00:00.000Z" }] }