User Properties

Remove Value From List

This API enables you to remove existing values from the list type properties of your users listed in your User Profiles. If the specified distinct ID or list property doesn't exist, it simply accepts the remove request and ignores it.

Note: This API can only be used to remove values from list and can remove only one value from a property at a time. To unset (nullify) other property types, please use Unset User Property API.

post/{WSID}/{version}/profiles/properties/list-remove

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

$removeRemoveFromUserPropertyListFields required

Enter the property name as JSON key and the value to remove as JSON value

distinct_idstring required

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

Example request

{
  "$remove": {
    "property_1": "some text",
    "property_2": 123,
    "property_3": 45.67,
    "property_4": "2020-10-01T18:30:00.000Z",
    "property_5": "2021-12-01",
    "property_n": "2021-11-01T13:35:00+02:00"
  },
  "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 3 of the 35 revisions of this API.36

Feb 17, 2025ee2cf82f4e6a5See the full diff
- ○
  added subschema #3 to the $remove/additionalProperties/ request property oneOf list
  request-property-one-of-added
- ○
  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, 2025f9c2e33f32473See the full diff
- ●
  removed the request property $remove/property_1
  request-property-removed
- ●
  removed the request property $remove/property_2
  request-property-removed
- ●
  removed the request property $remove/property_n
  request-property-removed
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