Skip to main content

SDK - Config Parameter Update

Endpoint

/i/sdk-config/update-parameter

Overview

Updates SDK config document for an app using parameter payload.

Authentication

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

Permissions

Requires sdk 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.
parameterString (JSON Object) or ObjectYesFull SDK config object to save under config.

Examples

Update SDK config via parameter payload

/i/sdk-config/update-parameter?api_key=YOUR_API_KEY&app_id=6991c75b024cb89cdc04efd2&parameter={"tracking":true,"crt":true,"eqs":100}

Response

Success Response

{
"result": "Success"
}

Response Fields

FieldTypeDescription
resultStringSuccess when config is saved.

Error Responses

  • 400
{
"result": "Error parsing parameter"
}
  • 400
{
"result": "Missing parameter \"app_id\""
}

Behavior

  • Parses parameter if provided as JSON string.
  • Saves payload as full config object for app.
Implementation details

Database Collections

CollectionUsed forData touched by this endpoint
countly_out.sdk_configsSDK config storageUpserts app config as { _id: app_id, config: parameter }.