Pin or Unpin a Note
Toggles whether a note is pinned. Any team member may toggle a pin (not just the author). Pinned notes sort to the top.
Path Parameters
- id (required, string): Note ID, from List Notes.
Request Body
Example Request
Response (201)
Returns the updated note object with the newis_pinned, pinned_at, and pinned_by values.
Errors
Authorizations
Team-scoped API key generated in the Salesfinity dashboard under Settings -> Connections & API. A missing or invalid key returns HTTP 403.
Path Parameters
Note ID
Body
ID of the team member toggling the pin. Must be a member of the team that owns the API key.
"507f1f77bcf86cd799439011"
Response
Pin toggled successfully
"507f1f77bcf86cd799439011"
"507f1f77bcf86cd799439012"
Note author. Populated when available; otherwise just the user ID under _id.
Plain text content of the note
Whether this note is pinned to the top
Contact this note is attached to (mutually exclusive with company)
Company this note is attached to (mutually exclusive with contact)