Updates to Enumeration Properties in Custom Quotes and how to fetch labels and internal values

[dennisedson]

We are updating the JSON returned for custom enumeration properties to include BOTH the internal value as well as the external label.  For CMS Developers, we have updated the crm_property_definition function to be available outside of gated content. 

The updated JSON will be rolled out over the course of 5 days starting July 22nd and ending July 26th 2024. The HubL function is available now. 

What’s Changing

Recently, we deployed a change to the returned data for custom enumeration properties for quotes. Prior to this change, we provided only the internal value of the property instead of the external-facing label. We updated the response to return only the external label. However, this change adversely affected many custom quote templates, so we paused the rollout.

We are updating the response to include a new JSON node with both the internal value and the external label, which should accommodate those using either type.  

An example of the JSON looks like this:

custom_properties: {
  my_custom_property: {
    label:"Label1",
    internal:"value1"
  },
  another_custom_property: {
    label:"Label99",
    internal:"value99"
  }
}

For CMS Developers who are building in the CMS with custom quote templates, we are removing restrictions from the crm_property_definition function to allow it to be used outside of gated content. This will allow you to replace the label with the value where necessary.  For example

{% set dealEnum = template_data.quote.associated_objects.deal.deal_enum %}  
{% set dealEnumProp = crm_property_definition("DEAL", "deal_enum").options|selectattr('label', "equalto", dealEnum)|first %}
{{ dealEnumProp.value }}

 

When is this happening?

We will begin rolling the updated JSON response from July 22nd through July 26th, 2024 to all accounts. The ability to use the HubL function outside of gated content is available now. We will restart the initial rollout that was paused for all accounts starting August 21, 2024. Please note that the initial rollout will be enforced on ALL custom enumeration properties on custom quotes.  Refer to the knowledge base documentation for a list of all enumeration property types.