Breaking Change in the Qlik Application Automation HubSpot 'Get Contact by Email' block (30th May 2025)

[Sonja_Bauernfeind]

The Qlik Application Automation HubSpot block Get Contact by Email has been updated to the latest API version, pointing it to HubSpot v3 API.

What has changed?

Input Parameter changes 

The new version changes how input parameters are handled. While the current (old) block returns all properties by default, the new block requires explicitly specifying the fields you need.

Input Parameters available in the old (current) block:

• Email

Input Parameters available in the new block:

• Email
• Properties
• Properties With History
• Associations

By default, it will only fetch data as shown in the example below. If additional details are required, input parameters like Properties, Properties With History, and Associations must be added.

Default example:

{
"id": "1",
"properties": {
"createdate": "2021-07-27T13:13:25.669Z",
"email": "emailmaria@hubspot.com",
"firstname": "Marino",
"hs_object_id": "1",
"lastmodifieddate": "2023-07-27T23:18:09.664Z",
"lastname": "Johnson (Sample Contact)"
},
"createdAt": "2021-07-27T13:13:25.669Z",
"updatedAt": "2023-07-27T23:18:09.664Z",
"archived": false,
"key_values": {
"createdate": null,
"email": null,
"firstname": null,
"hs_object_id": null,
"lastmodifieddate": null,
"lastname": null
}
}

 

Response changes 

Top-Level Structure Differences:

Old Response:

• Uses "vid" as the contact identifier.
• Contains "canonical-vid" and "merged-vids" for tracking multiple contact records.
• "portal-id" is included to indicate the HubSpot account.

New Response:

• Uses "id" as the contact identifier instead of "vid".
• Omits "canonical-vid", "merged-vids", and "portal-id".

Properties Structure:

Old Response:

• Each property has "value" and "versions" fields to track changes over time.
• "versions" include timestamps, sources, and previous values.

New Response:

• Properties are flattened, storing only the latest value under "properties".
• Historical values are now under "propertiesWithHistory", making the structure more modular.

Timestamp Format:

• Old Response: Uses Unix timestamps (e.g., "1627391605669").
• New Response: Uses ISO 8601 format (e.g., "2021-07-27T13:13:25.669Z"), making it more human-readable.

Data Organization:

• Old Response: Mixes computed, user-set, and system-set fields within "properties", making it harder to distinguish sources.
• New Response: Separates historical data into "propertiesWithHistory", improving clarity.

See the attached .JSON files for comparison responses between the old (hubspot-old-get-contact-by-email.json) and the new (hubspot-new-get-contact-by-email.json) block.

How will this affect me?

If you currently use the HubSpot connector's Get Contact by Email block and do not upgrade it to the new version, the block will stop functioning on May 30th, 2025.

How do I prepare for the change?

• Update your automations to use the new Get Contact by Email block: 
  1. Select the old block
  2. Then click Upgrade to latest version
     
     
     
     
• Since the response has changed, modify the output reference in other blocks once you have upgraded the Get Contact by Email block. Failing to do so will lead to an input parameter with a null value and cause referenced blocks to fail with the error "Missing mandatory parameter" wherever the input parameter is mandatory.
  
  Example error:

  {
  "response": {
  "status": 400,
  "body": {
  "errors": [
  {
  "code": "HTTP-400",
  "title": "Invalid Request.",
  "detail": "Missing mandatory parameter \"id\"."
  }
  ]
  }
  },
  "external error": false
  }

If you have any questions, we're happy to assist. Reply to this blog post or take similar queries to the Qlik Application Automation forum.

Thank you for choosing Qlik,
Qlik Support

hubspot-new-get-contact-by-email.json

hubspot-old-get-contact-by-email.json