Contents

Changelog

UPDATE
Effective from:

March 29, 2023

Update to the breaking change in label response field’s data type for Deals

Announced: March 15, 2023

Effective from:
March 29, 2023

On November 18, 2022, we announced a breaking change in the label response field’s data type for Deals with a 2-month warning period.

The initial end date of the grace period has passed without the change going live. We want to apologize for any confusion or inconvenience this may have caused. Our team has been working hard to ensure that the change is fully ready to be rolled out, and we strongly believe this will improve the capabilities of our platform in the long run.

We are now excited to announce that from March 29, 2023, we will start the gradual rollout of this change.

What is changing?

All the technical details from the original announcement still apply:

For deals, the data type of a label’s ID will be changed from integer to string:

  • If the deal has a single label specified, it will be returned as a string
  • If the deal has multiple labels specified, it will be returned as a comma-separated string

The change affects the following deals-related endpoints:

Similarly, the data type of a label’s ID will be changed from integer to string in the response payload of the deal v1 webhook.

For the GET /dealFields and GET /dealFields/{id} endpoints, the field_type associated with the “key”: “label” response object will be set, instead of the current enum type.

Why is it changing?

We are changing the data type of a deal’s label response field from integer to string to support the functionality of having multiple labels in one deal, which will be introduced in our web app.

Who will be affected?

Everyone using the specified endpoints to retrieve the labels of a deal.

If you have any questions or comments, let us know in the Developer’s Community.

Subscribe to our
Changelog

You may unsubscribe anytime using the unsubscribe link in our emails. For more information, please see our privacy notice.

Subscribe to our
Changelog

You may unsubscribe anytime using the unsubscribe link in our emails. For more information, please see our privacy notice.