Contents
Changelog
January 17, 2023
label
response field’s data type for DealsAnnounced: November 18, 2022
January 17, 2023
UPDATE: The implementation of this change has been delayed. We apologize for any confusion or inconvenience this may have caused. From March 29, 2023, we are starting the gradual rollout of this change. Please refer to the updated announcement in Changelog for further details.
What is changing?
From January 17, 2023, the data type of a deal’s label
response field will be changed from integer
to string
:
- If the deal has a single label specified, the label ID will be returned as a
string
- If the deal has multiple labels specified, the label IDs will be returned as a comma separated
string
The change affects the following deals-related endpoints:
GET /deals
GET /deals/{id}
GET /deals/timeline
GET /organizations/{id}/deals
GET /persons/{id}/deals
GET /pipelines/{id}/deals
GET /products/{id}/deals
GET /stages/{id}/deals
POST /deals
POST /deals/{id}/duplicate
PUT /deals/{id}
PUT /deals/{id}/merge
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.