HubSpot Developer Changelog

Upcoming Sunset of Legacy Pipeline Stage Calculated Properties for Contacts and Deals

Written by Dennis Edson | Aug 13, 2024 1:03:57 PM

We have introduced a new set of pipeline stage calculated properties for the contacts and deals objects that offer more functionality than their predecessors.  With the introduction of these new properties, we will be sunsetting the corresponding legacy properties.  These properties will cease to be available or function on November 20, 2024.  

What’s changing

We have added new stage calculated properties for contacts and deals which are available today. These properties include the following.

  • hs_v2_date_entered_{stage_id}
  • hs_v2_date_exited_{stage_id}
  • hs_v2_latest_time_in_{stage_id}
  • Hs_v2_cumulative_time_in_{stage_id}

Note: the {stage_id} value in the property names above may exactly match the stage ID on the pipeline stage, or it may be altered slightly to conform to property naming rules.  For example, a hyphen in the ID of a pipeline stage may be substituted with an underscore in the corresponding property name.

With the availability of these new properties, we will be sunsetting the following legacy versions which include the following.

  • hs_lifecyclestage_{stage id}
  • hs_date_entered_{stage id}
  • hs_date_exited_{stage id}
  • hs_time_in_{stage id}

The legacy properties do behave differently than the new, improved properties and may result in different values. Some key differences:
  • legacy properties clear data when an object moves backwards.
  • legacy properties auto-populate data when an object skips stages.
  • the new v2 properties do NOT behave in this way.
When switching over from the legacy properties to the new properties, there may well be some differences in values based on the above. It's important to remember that the data of the new properties provide higher data accuracy than the legacy ones.
 
What do you need to do

There is no need to merge the new data with the old. Integrations only need to switch over to the new v2 properties. The new properties were backfilled and should offer historical values.

Now that there is a replacement set of properties for the legacy properties, integrators will need to migrate to the new v2 properties by November 20th, 2024.

When is this happening

The new properties are available now.  The legacy properties will stop being returned for any API request beginning on November 20th, 2024.  

Questions or comments? Join us in the developer forums.