Skip to main content

Update funnel groups

Endpoint​

/i/funnels/group

Ⓔ Enterprise Only
This API is available exclusively in Countly Enterprise.

Overview​

Updates funnel group flags (including favorite group flags) for a funnel.

Authentication​

Countly API supports three authentication methods:

  1. API key query parameter: api_key=YOUR_API_KEY
  2. Auth token query parameter: auth_token=YOUR_AUTH_TOKEN
  3. Auth token header: countly-token: YOUR_AUTH_TOKEN

Permissions​

Requires funnels Update permission.

Request Parameters​

ParameterTypeRequiredDescription
app_idStringYesTarget app ID.
funnel_idStringYesFunnel ID to update groups for.
groupsJSON String (Object)YesGroup map where truthy values are set and falsy values are unset.
api_keyStringConditionalRequired if auth_token is not provided.
auth_tokenStringConditionalRequired if api_key is not provided.

Response​

Success Response​

{
  "result": "Success"
}

Response Fields​

FieldTypeDescription
resultStringGroup update result.

Error Responses​

  • 400
{
  "result": "Not enough args"
}
  • 400
{
  "result": "Cannot save data"
}
  • 404
{
  "result": "Funnel not found"
}

Behavior/Processing​

  • Parses groups JSON object.
  • For each key, truthy values are written to groups.<key> = 1, falsy values are removed via $unset.
  • Requires existing funnel match by _id and app_id.
  • Writes funnel_edited system log entry with before/update payload.

Database Collections​

CollectionUsed forData touched by this endpoint
countly.funnelsEndpoint data sourceStores endpoint-related records this endpoint reads or modifies.
countly.systemlogsAudit trailContains system action records used by this endpoint for audit output or audit writes.

Examples​

/i/funnels/group?
  app_id=64f5c0d8f4f7ac0012ab3456&
  funnel_id=67f1c22912df5acb8f8d5caaf0f89a31&
  groups={"fav_64f5c0d8f4f7ac0012ab9999":true,"marketing":true}
/i/funnels/group?
  app_id=64f5c0d8f4f7ac0012ab3456&
  funnel_id=67f1c22912df5acb8f8d5caaf0f89a31&
  groups={"marketing":false}

Last Updated​

2026-02-16