Skip to main content

Remote Config - Parameter Update

Endpoint​

/i/remote-config/update-parameter

Overview​

Updates an existing remote config parameter by id.

Authentication​

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

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.
parameter_idStringYesParameter document id.
parameterString (JSON Object)YesUpdated parameter payload.

Parameter Structure (parameter)​

FieldTypeRequiredDescription
parameter_keyStringYesMust match ^[a-zA-Z_][a-zA-Z0-9_]*$.
default_valueAnyYesUpdated default value.
statusStringNoDefaults to Running when omitted.
conditionsArrayNoUpdated condition-value list.

Examples​

Update parameter default value​

/i/remote-config/update-parameter?api_key=YOUR_API_KEY&app_id=6991c75b024cb89cdc04efd2&parameter_id=65f1f7b2ad5b9b001f12ab34&parameter={"parameter_key":"button_color","default_value":"#00AA55","conditions":[]}

Response​

Success Response​

{}

Response Fields​

No fields are returned on success for this endpoint.

Error Responses​

  • 400
{
"result": "Invalid parameter: parameter_key"
}
  • 400
{
"result": "Invalid parameter: default_value"
}
  • 500
{
"result": "The parameter already exists"
}
  • 500
{
"result": "Maximum conditions limit reached"
}

Behavior​

  • Parses parameter JSON string.
  • Sets status to Running when missing.
  • Rebuilds valuesList and merges with existing valuesList using $addToSet.
  • Emits system log action: rc_parameter_edited with before/after snapshot.

Limitations​

  • parameter must contain both parameter_key and default_value.
Implementation details

Configuration Impact

SettingDefaultAffectsUser-visible impact
remote-config.conditions_per_paramaeters20Validation limitUpdate fails when provided condition list exceeds max.

Database Collections

CollectionUsed forData touched by this endpoint
countly_out.remoteconfig_parameters{appId}Parameter storageValidates uniqueness and updates parameter document by id.
countly.systemlogsAudit trailReceives rc_parameter_edited action.