FYfynoio
User Properties

Unset User Property

Changed on

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

Request

  • Base URL
    https://api.fyno.io/v1
  • URL
    https://api.fyno.io/v1/{WSID}/{version}/profiles/properties/unset
  • 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

$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

  • 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

      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