Change Note state to pinned via API?

Developer Support APIs & Integrations
,
1

Maybe someone knows how to change Note state to pinned via API or create it immediately with such state?

2

Hi, @RamanR :waving_hand: Thanks for your question. I did not see anything in the Notes endpoints documentation showing this is an option. I was curious, though.

Here’s my extra steps:

  • Make a request to the Properties API and parse it for a `flag` or other matching property (I didn’t spot it)GET https://api.hubapi.com/crm/v3/properties/notes?archived=false​

  • Create a note on an object record, pin it, and then make a request to view the engagement. There wasn’t any additional property or other indication of the “pinning” action returned, unfortunately

    curl --request GET \
 --url 'https://api.hubapi.com/crm/v3/objects/notes/41892435789?archived=false' \
 --header 'authorization: Bearer YOUR_ACCESS_TOKEN'​

    HTTP 200

{
 "id": "41892435789",
 "properties": {
 "hs_createdate": "2023-10-27T22:35:33.019Z",
 "hs_lastmodifieddate": "2023-10-27T22:35:33.019Z",
 "hs_object_id": "41892435789"
 },
 "createdAt": "2023-10-27T22:35:33.019Z",
 "updatedAt": "2023-10-27T22:35:33.019Z",
 "archived": false
}

I agree, this would be a useful addition to the options for Notes created via the API. If you have a moment, adding your suggestion to the Ideas Community and getting some upvotes will be very helpful in getting your suggestion in front of the Product team. If you add a link back to your Idea post, I’ll be sure to give it an upvote to help get the ball rolling.

Best,

Jaycee

3

Thank you for your reply.
I’ve created a idea.

https://community.hubspot.com/t5/HubSpot-Ideas/Change-the-state-of-a-note-to-pinned-via-API/idi-p/871860#M158956

4

Hi,

what is below is not in official documentation but it works.

PUT https://app.hubspot.com/api/engagements/v1/pinned/{{OBJECT TYPE}}/{{OBJECT ID}}/{{NOTE ID}}

OBJECT TYPE → object type in which you want to PIN note, ie. ticket

OBJECT ID → object ID
NOTE ID → note ID you want to pin

To remove pin use below call

DELTE https://app.hubspot.com/api/engagements/v1/pinned/{{OBJECT TYPE}}/{{OBJECT ID}}

To get pinned engagement to oject use this call

GET https://app.hubspot.com/api/engagements/v1/pinned/{{OBJECT TYPE}}/{{OBJECT ID}}

let me know if it works for you and rememer to mark it as solution.