User Properties

Unset User Property

This API enables you to unset (nullify) user properties of your users listed in your User Profiles. If the specified distinct ID or property doesn't exist, it simply accepts the unset request and ignores it. This API can be used to unset all property data types: String, Number, Boolean, Date, List.

post/{WSID}/{version}/profiles/properties/unset

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

$unsetstring[] required

Enter the property names to unset in an array

distinct_idstring required

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

Example request

{
  "$unset": [
    "property_1",
    "property_2",
    "property_n"
  ],
  "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"
}

Changes

Changed in 2 of the 35 revisions of this API.5

Feb 17, 2025ee2cf82f4e6a4See the full diff
- ○
  the response property _message became required for the status 400
  response-property-became-required
- ○
  the response property _message became required for the status 401
  response-property-became-required
- ○
  the response property status became required for the status 400
  response-property-became-required
- ○
  the response property status became required for the status 401
  response-property-became-required
Feb 12, 20254a67858d11ce1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 22 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history