Changes to fields in the Workflows API

[Dadams]

We're making some changes to some of the fields used in the Workflows API. Certain optional fields will no longer be included in the response for any workflow and other fields will have static, empty values regardless of how the fields may be set when creating a workflow. We're also fixing an issue with special characters in the name of the workflow.

Why is this happening?

These fields no longer accurately reflect the actual state of the workflow. Most of them have been superseded by other fields, were used for functionality that is no longer supported, or do not contain useful data.

What's changing?

The following fields will be affected:

• onlyExecOnBizDays - This is an optional field that will no longer be returned - This field is no longer used. The current feature to only execute workflows at specific times is not compatible with this field.
• nurtureTimeRange - This is an optional field that will no longer be returned - Similar to onlyExecOnBizDays, this field is no longer used and is not compatible with similar current functionality.
• contactListIds - This field will be set to {} (empty map) - The IDs returned in this field are internal IDs that are not used or returned by any other APIs.
• internalStartingListId - This is an optional field that will no longer be returned - The ID returned in the field is an internal ID that is not used or returned by other APIs.
• internalGoalListId - This is an optional field that will no longer be returned - The ID returned in the field is an internal ID that is not used or returned by other APIs.
• onlyEnrollsManually - This is an optional field that will no longer be returned - The value of this field is ignored, and the enrollment functionality is set by the segmentCriteria field.
• triggeredByWorkflowIds - This field will be set to [] (empty list) - This field is no longer used for any functionality.
• removeContactFromExistingFlows - This is an optional field that will no longer be returned - The value of this field is ignored, and the functionality is set by the unenrollmentSetting field.
• triggerSets - This field will be set to [] (empty list) - This field is no longer used.

Additionally, you may see changes to the name field depending on the endpoint being used to get the workflow and the characters used in the name of the workflow. Currently, the GET workflow endpoint will always return the full name of the workflow, but other endpoints (including GET all workflows) do not currently support special characters such as emojis. Due to how the values for the names are stored, these other endpoints will return an older version of the name, before the emojis were added, so you will see an old name that does not match the name seen in HubSpot or that is returned from the endpoint to get the details for a single workflow. Starting on June 10, all endpoints will be updated to return the correct, current name of the workflow.

Since the functionality of these fields has been obsolete for some time already, no actual functionality will be changing, but you will see the values of these fields or the inclusion of certain optional fields change for existing workflows.

When is this happening?

The changes to the name field will go into effect on June 10th.

The changes for all other fields will go into effect on August 10th.

Please let us know if you have any questions by replying below.