Replacing the note field in Leads API with fields in Notes API

What is going to change?

We will remove the note field from the following Leads API endpoints:

• GET /leads
• GET /leads/{id}
• POST /leads
• PATCH /leads/{id}

And add lead_id and pinned_to_lead_flag fields to GET /notes endpoint.

Why is it going to change?

Until recently, we only supported having a single note for a Lead. Now we are adding support for multiple Notes. In doing so, it requires to stop using the note property on a Lead (which is in 1:1 relation) and start using the Note entity. The Note entity can be then linked to a Lead and thus it will be in a 1:N Lead to Note relation.

Until the grace time is over, we will create a Note object every time someone calls POST /leads with a note parameter. We will return and update the FIRST Note linked to a Lead on a GET and PATCH call. Therefore when using our API before the grace time is over, the only change will be that in the background a Note object will be created.

The note field will be removed on April 23, 2021. The support for multiple Notes is effective immediately.

Published on March 23, 2021