Update funnel groups

Enterprise

This endpoint is part of Countly Enterprise. To get access, contact sales or compare versions. Existing customers can reach the support portal with questions.

Endpoint

/i/funnels/group

Overview

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

Authentication

Pass api_key or auth_token as a query parameter, or send countly-token as a header. See Authentication.

Permissions

Requires funnels Update permission.

Request Parameters

Parameter	Type	Required	Description
app_id	String	Yes	Target app ID.
funnel_id	String	Yes	Funnel ID to update groups for.
groups	JSON String (Object)	Yes	Group map where truthy values are set and falsy values are unset.
api_key	String	Conditional	Required if auth_token is not provided.
auth_token	String	Conditional	Required if api_key is not provided.

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}

Response

Success Response

{
  "result": "Success"
}

Response Fields

Field	Type	Description
result	String	Group update result.

Error Responses

• 400

{
  "result": "Not enough args"
}

• 400

{
  "result": "Cannot save data"
}

• 404

{
  "result": "Funnel not found"
}

Behavior

• 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.

Related Endpoints

• Funnels - Update
• Funnels - List

Implementation details

Database Collections

Collection	Used for	Data touched by this endpoint
countly.funnels	Endpoint data source	Stores endpoint-related records this endpoint reads or modifies.
countly.systemlogs	Audit trail	Contains system action records used by this endpoint for audit output or audit writes.