Skip to main content

Remote Config - Condition Create

Endpoint

/i/remote-config/add-condition

Overview

Creates a condition document used for targeting parameter values.

Authentication

Countly API supports three authentication methods:

  1. api_key=YOUR_API_KEY
  2. auth_token=YOUR_AUTH_TOKEN
  3. countly-token: YOUR_AUTH_TOKEN

Permissions

Requires remote_config Update permission.

Request Parameters

ParameterTypeRequiredDescription
api_keyStringYes (or use auth_token)API key for authentication.
auth_tokenStringNoAuth token as query parameter or countly-token header.
app_idStringYesApp id.
conditionString (JSON Object)YesCondition payload.

Condition Structure (condition)

FieldTypeRequiredDescription
condition_nameStringYesMust match ^[a-zA-Z0-9 ]+$.
condition_colorNumberYesColor index used by dashboard.
conditionObject/StringYesCondition query definition.
seed_valueStringNoSeed used in rollout percentile logic.

Response

Success Response

"65f1f7b2ad5b9b001f12ab34"

Response Fields

FieldTypeDescription
(root)StringNewly created condition id.

Error Responses

  • 400
{
"result": "Invalid parameter: condition_name"
}
  • 400
{
"result": "Invalid parameter: condition_color"
}
  • 400
{
"result": "Invalid parameter: condition"
}
  • 500
{
"result": "The condition already exists"
}

Behavior/Processing

  • Parses condition JSON string.
  • Serializes nested condition.condition object to JSON string before storing.
  • Emits system log action: rc_condition_created.

Database Collections

CollectionUsed forData touched by this endpoint
countly_out.remoteconfig_conditions{appId}Condition storageValidates duplicates and inserts condition document.
countly.systemlogsAudit trailReceives rc_condition_created action.

Examples

Create condition

/i/remote-config/add-condition?api_key=YOUR_API_KEY&app_id=6991c75b024cb89cdc04efd2&condition={"condition_name":"iOS Users","condition_color":1,"condition":{"up._os":{"$eq":"iOS"}},"seed_value":"button_color"}

Last Updated

2026-03-05