Skip to main content
Contributor I
Nov 27, 2022 7:53 AM UTC
Solved

How do I delete a custom property with the new API

This is the API:
https://developers.klaviyo.com/en/reference/update_profile

I want to delete a custom tag from a certain profile via API.
Delete, not set to blank or null.

(In the legacy API, I managed to use the “$unset” successfully.)

    Brian Turcotte
    Klaviyo Alum
    Nov 28, 2022 6:13 PM UTC

    Hi @meitalmtz and welcome to the Community!

     

    The $unset feature that was available but undocumented in the v1-2 APIs is actually out of scope for the new APIs, so it’s not possible to delete profile properties with the new APIs at the moment. 

     

    However, this feature is being considered for reimplementation in future releases, so I will update the thread if there’s any news there. In the meantime, the legacy APIs won’t be end-of-lifed until January of 2024, so you can still use them to remove properties as outlined in these Community posts:

     

    I hope this helps to clarify, and thanks for using the Community!

     

    - Brian

    2 replies

    Brian Turcotte
    Klaviyo Alum
    Nov 28, 2022 6:13 PM UTC

    Hi @meitalmtz and welcome to the Community!

     

    The $unset feature that was available but undocumented in the v1-2 APIs is actually out of scope for the new APIs, so it’s not possible to delete profile properties with the new APIs at the moment. 

     

    However, this feature is being considered for reimplementation in future releases, so I will update the thread if there’s any news there. In the meantime, the legacy APIs won’t be end-of-lifed until January of 2024, so you can still use them to remove properties as outlined in these Community posts:

     

    I hope this helps to clarify, and thanks for using the Community!

     

    - Brian

    Contributor I
    Mar 14, 2025 4:13 PM UTC

    Hello, 

     

    Any update on this, I have tried to use null to delete a custom property but it did not remove the property at all.

     

    As the old API has reached it’s end of life, I am also unable to use the $unset function.

     

    Please let me know the best way to procced.