FYfynoio
User Properties

Remove Value From List

Changed on

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

Request

  • Base URL
    https://api.fyno.io/v1
  • URL
    https://api.fyno.io/v1/{WSID}/{version}/profiles/properties/list-remove
  • Auth
    HTTP bearer

Path parameters

WSIDstring required

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

versionstring 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

  • f620f85db863Revision changes
    • breaking

      removed the enum value live from the path request parameter version

    • breaking

      removed the enum value test from the path request parameter version

  • ee2cf82f4e6aRevision changes
    • info

      added subschema #3 to the / request property oneOf list

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status