Sign in

v33

latestOpenAPI 3.0.2raw.githubusercontent.com2026-03-142353151.8 KB
User Properties

Increment/Decrement Numeric Property

This API enables you to increment/decrement values of numeric properties of your users listed in your User Profiles. If the user with distinct ID doesn't exist, it creates a new user with the provided distinct ID and updates values for all the provided properties. To decrement property values, you can pass a negative value.<br/><br/>Note: If a property was not created earlier, it will create a new property and the data type of the property will set to Number. For example, if you $add a new property called ltv=1200, it will create the ltv property with Number type and value 1200. Do not enclose the value in double quotes as they must be of numeric type.<br/><br/>These user properties can be used to filter your users for creating user cohorts and campaigns.

post/{WSID}/{version}/profiles/properties/numerical-add

Path parameters

WSIDstring required

Enter your workspace ID. You can obtain this value from the API Keys page within your Fyno account.

version'live' | 'test' required

Specify the version for which you would like to update the user property.

Request body

$addIncrementUserPropertyFields required

Enter the property name as JSON key and the numeric value to increment/decrement as JSON value

distinct_idstring required

Enter the distinct ID that you use to identify the recipient.

Example request

{
  "$add": {
    "property_1": 23.4,
    "property_2": 20301,
    "property_n": -39.45
  },
  "distinct_id": "XXXXXXXX"
}

Response

Request has been accepted and will be processed asynchronously.

request_idstring required

Example response

{
  "request_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
}