Batch Update User Properties | Fyno Documentation

This API enables you to modify user properties of your users listed in your [User Profiles](../user-profiles-overview) in bulk: <ul><li>[Update User Properties](./update-user-property) - `$set`</li><li>[Set Unset Properties](./set-an-unset-property) - `$once`</li><li>[Increment/Decrement Numeric Properties](./increment-decrement-numeric-property) - `$add`</li><li>[Append Values to List](./append-values-to-list) - `$append`</li><li>[Remove Values From List](./remove-value-from-list) - `$remove`, and</li><li>[Unset User Properties](./unset-user-property) `$unset`</li></ul>Please refer to function specific API documentation for [$set](./update-user-property), [$once](./set-an-unset-property), [$add](./increment-decrement-numeric-property), [$append](./append-values-to-list), [$remove](./remove-value-from-list), [$unset](./unset-user-property) before using this API. **Note:** The user properties in User Profiles can be used to filter your users for creating [user cohorts](../creating-cohorts) and [campaigns](../campaign_creation#creating-a-campaign-using-cohort).

This API enables you to modify user properties of your users listed in your User Profiles in bulk:

Update User Properties - $set
Set Unset Properties - $once
Increment/Decrement Numeric Properties - $add
Append Values to List - $append
Remove Values From List - $remove, and
Unset User Properties $unset

Please refer to function specific API documentation for $set, $once, $add, $append, $remove, $unset before using this API.

Note: The user properties in User Profiles can be used to filter your users for creating user cohorts and campaigns.

Authentication

AuthorizationBearer

Enter your API Key. If you don't have it already, you can create one from the API Keys page within your Fyno account

Path parameters

WSIDstringRequired

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

versionenumRequiredDefaults to live

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

Allowed values:

Request

This endpoint expects an object.

batchlist of objectsRequired

Enter an array of objects with distinct_id and action to perform on the user properties

Response

Request has been accepted and will be processed asynchronously.

request_idstring

batchlist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

$	curl -X POST https://api.fyno.io/v1/FYXXXXXXXX/live/profiles/properties/batch \
>	-H "Authorization: Bearer <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"batch": [
>	{
>	"distinct_id": "XXXXXXXX",
>	"action": {}
>	}
>	]
>	}'

1	{
2	"request_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
3	"batch": [
4	{
5	"$set": "ok",
6	"$once": "ok",
7	"$add": "ok",
8	"$append": "ok",
9	"$remove": "ok",
10	"$unset": "ok"
11	}
12	]
13	}

$	curl -X POST https://api.fyno.io/v1/FYXXXXXXXX/live/profiles/properties/batch \
>	-H "Authorization: Bearer <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"batch": [
>	{
>	"distinct_id": "XXXXXXXX",
>	"action": {}
>	}
>	]
>	}'

1	{
2	"request_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
3	"batch": [
4	{
5	"$set": "ok",
6	"$once": "ok",
7	"$add": "ok",
8	"$append": "ok",
9	"$remove": "ok",
10	"$unset": "ok"
11	}
12	]
13	}