---
title: "Unset User Property"
method: POST
path: "/{WSID}/{version}/profiles/properties/unset"
tags: ["User Properties"]
---

# Unset User Property

`POST /{WSID}/{version}/profiles/properties/unset`

This API enables you to unset (nullify) user properties of your users listed in your [User Profiles](../user-profiles-overview). 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.

## Path parameters

- `WSID` string, required
- `version` 'live' | 'test', required

## Request body

- UnsetUserProperty
  - `$unset` string[], required — Enter the property names to unset in an array
  - `distinct_id` string, required — Enter the distinct ID that you use to identify the recipient.

## Response `202`

Request has been accepted and will be processed asynchronously.

- object
  - `request_id` string, required

## Other responses

- `400` — $unset object is empty
- `401` — API Key or Workspace ID is invalid. User is unauthorised.

## Changes

- **2025-02-17** `ee2cf82f4e6a` — 4 info
  - the response property `_message` became required for the status `400`
  - the response property `_message` became required for the status `401`
  - the response property `status` became required for the status `400`
  - the response property `status` became required for the status `401`
- **2025-02-12** `4a67858d11ce` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/fynoio/apis/fyno-rest-api/changes/:WSID/:version/profiles/properties/unset/post.md)

---

[API](https://skmtc.dev/fynoio/apis/fyno-rest-api.md) · [All operations](https://skmtc.dev/fynoio/apis/fyno-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fynoio/fyno-rest-api/revisions/ee288e1ee67d/schema)