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
| Parameter | Type | Required | Description |
|---|---|---|---|
api_key | String | Yes (or use auth_token) | API key for authentication. |
auth_token | String | No | Auth token as query parameter or countly-token header. |
app_id | String | Yes | App id. |
parameter_id | String | Yes | Parameter document id. |
parameter | String (JSON Object) | Yes | Updated parameter payload. |
Parameter Structure (parameter)
| Field | Type | Required | Description |
|---|---|---|---|
parameter_key | String | Yes | Must match ^[a-zA-Z_][a-zA-Z0-9_]*$. |
default_value | Any | Yes | Updated default value. |
status | String | No | Defaults to Running when omitted. |
conditions | Array | No | Updated condition-value list. |
Examples
Update parameter default value
/i/remote-config/update-parameter?api_key=YOUR_API_KEY&app_id=6991c75b024cb89cdc04efd2¶meter_id=65f1f7b2ad5b9b001f12ab34¶meter={"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
parameterJSON string. - Sets
statustoRunningwhen missing. - Rebuilds
valuesListand merges with existingvaluesListusing$addToSet. - Emits system log action:
rc_parameter_editedwith before/after snapshot.
Limitations
parametermust contain bothparameter_keyanddefault_value.
Related Endpoints
Implementation details
Configuration Impact
| Setting | Default | Affects | User-visible impact |
|---|---|---|---|
remote-config.conditions_per_paramaeters | 20 | Validation limit | Update fails when provided condition list exceeds max. |
Database Collections
| Collection | Used for | Data touched by this endpoint |
|---|---|---|
countly_out.remoteconfig_parameters{appId} | Parameter storage | Validates uniqueness and updates parameter document by id. |
countly.systemlogs | Audit trail | Receives rc_parameter_edited action. |