Batch Update User Properties
This API enables you to modify user properties of your users listed in your User Profiles in bulk:<br/><ul><li>Update User Properties - $set</li><li>Set Unset Properties - $once</li><li>Increment/Decrement Numeric Properties - $add</li><li>Append Values to List - $append</li><li>Remove Values From List - $remove, and</li><li>Unset User Properties $unset</li></ul><strong>Please refer to function specific API documentation for $set, $once, $add, $append, $remove, $unset before using this API.</strong><br/></br><br/>Note: The user properties in User Profiles can be used to filter your users for creating user cohorts and campaigns.
Path parameters
Enter your workspace ID. You can obtain this value from the API Keys page within your Fyno account.
Specify the version for which you would like to update the user property.
Request body
Example request
{
"batch": [
{
"distinct_id": "XXXXX",
"action": {
"$set": {
"property_1": "some text",
"property_2": 123,
"property_3": 45.67
},
"$once": {
"property_4": true,
"property_5": [
"iPhone 16 Pro",
"iPad 32 GB"
],
"property_6": "2020-10-01T18:30:00.000Z"
},
"$add": {
"property_7": 10.23,
"property_8": -11.9,
"property_9": 223
},
"$append": {
"property_10": "#12345",
"property_11": 2030,
"property_12": "2022-11-11T10:30:00+02:00"
},
"$remove": {
"property_13": "2023-11-10",
"property_14": "ABC1234",
"property_15": 4010
},
"$unset": [
"property_0",
"old_property1"
]
}
}
]
}Response
Request has been accepted and will be processed asynchronously.
Example response
{
"request_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"batch": [
{
"$set": "ok",
"$once": "ok",
"$add": "ok",
"$append": "ok",
"$remove": "ok",
"$unset": "ok"
}
]
}