Skip to main content

User Profiles - Update Properties (SDK)

Endpoint​

/i?app_key=YOUR_APP_KEY&device_id=docs_users_device&user_details={"name":"Docs User","custom":{"tier":"pro"}}

Ⓔ Enterprise Only
This API is available exclusively in Countly Enterprise.

Overview​

Updates user properties through SDK ingestion (/i) using user_details payload.

Authentication​

Authentication method:

  • App Key (parameter): app_key=YOUR_APP_KEY

SDK ingestion route:

  • /sdk/user_properties (no dashboard auth method; this is SDK ingestion path)

Permissions​

  • No dashboard feature permission check in this path; access is controlled by valid app_key and SDK ingestion rules.

Request Parameters​

ParameterTypeRequiredDescription
app_keyStringYesApp key
device_idStringYesDevice identifier
user_detailsString (JSON Object)YesUser properties update payload

Response​

Success Response​

{
  "result": "Success"
}

Response Fields​

FieldTypeDescription
resultStringSDK ingestion result

Error Responses​

  • HTTP 400 - Invalid request (example):
{
  "result": "Missing parameter \"app_key\""
}

Behavior/Processing​

  • Parses user_details JSON.
  • Applies update operators ($set, $unset, $inc, $push, $pull, $addToSet, etc.) where supported.
  • Enforces limits from User Profiles feature config (custom_set_limit, custom_prop_limit).
  • Persists updates via app users update dispatch.

Database Collections​

CollectionUsed forData touched by this endpoint
countly.app_users{appId}Per-app user profilesStores user-level properties and profile fields affected by this endpoint.

Examples​

/i?app_key=YOUR_APP_KEY&device_id=docs_users_device&user_details={"name":"Jane Doe","email":"jane@example.com"}
/i?app_key=YOUR_APP_KEY&device_id=docs_users_device&user_details={"custom":{"tier":"enterprise","plan":["pro","plus"]}}

Ⓔ Enterprise​

This feature is part of Countly Enterprise.

Get Access:

Already a Customer? Use support portal if you have any questions.

Last Updated​

2026-02-16