Skip to main content

funnelEdit

Replaces a saved funnel's name, visit baseline, and ordered goal steps; use funnelEditName to rename only. Revalidates that goals are accessible and belong to the site, then replaces all steps transactionally. Missing or inaccessible funnels return an error. Requires funnels edit access.

funnelEdit(
  id: Int!
  siteId: Int!
  name: String!
  visitStep: Boolean!
  goalSteps: [Int]!
): Funnel!

Arguments​

funnelEdit.id ● Int! non-null scalar​

Saved funnel ID from funnelList or funnelDetail.

funnelEdit.siteId ● Int! non-null scalar​

Site ID from sites that owns the funnel and every goal step.

funnelEdit.name ● String! non-null scalar​

Nonblank funnel display name.

funnelEdit.visitStep ● Boolean! non-null scalar​

True to prepend a site-wide visit baseline before the ordered goal steps.

funnelEdit.goalSteps ● [Int]! non-null scalar​

Ordered goal IDs from goalRefList, all accessible and belonging to siteId; matching uses the goals' configured triggers.

Type​

Funnel object​

Saved funnel definition returned by funnel list, detail, create, and edit operations. Use its ordered goals and optional visit baseline with funnelResult.