Upcoming: Replacing a property in the Feedback Submissions API

What's changing?

On August 8th, we will be removing the Feedback Sentiment (hs_response_group) property from the Feedback Submissions API. This property was designed around responses for NPS surveys, and only supports values of Detractor, Passive, and Promoter. Since launch, we've added new types of surveys with different response types, and so this property no longer supports each different type of survey.

We're going to replace the existing property with a new property named Sentiment (hs_sentiment). This new property will be able to support different response types for each different survey type, so the values will vary depending on the type of survey (recorded in the hs_survey_type property, or in the hs_industry_standard_question_type property for custom surveys):

• For a survey type of CSAT or for survey type CUSTOM with industry standard question type of CSAT:
  • A survey with rating 0 will have a sentiment value of Unhappy
  • A survey with rating 1 will have a sentiment value of Neutral
  • A survey with rating 2 will have a sentiment value of Happy.
• For a survey type of NPS or for survey type CUSTOM with industry standard question type of NPS:
  • A survey with rating 0-6 will have a sentiment value of Detractor
  • A survey with rating 7-8 will have a sentiment value of Passive 
  • A survey with rating 9-10 will have a sentiment value of Promoter.
• For a CES survey type:
  • A survey with rating 1-3 will have a sentiment value of Difficult
  • A survey with rating 4-5 will have a sentiment value of Neutral
  • A survey with rating 6-7 will have a sentiment value of Easy.

When is this happening?

The new Sentiment (hs_sentiment) property is available immediately, and can be used today. Any existing surveys will have the hs_sentiment property backfilled with the value of the Feedback Sentiment (hs_response_group) property, so the new property can be used for existing surveys.

The Feedback Sentiment (hs_response_group) property will be removed on August 8th. Any integrations using the hs_response_group property will need to be updated to use hs_sentiment before this date.

Please let us know if you have any questions by joining in the discussion in our community.