Skip to main content
POST
/
v2
/
notes
/
{id}
/
pin
Toggle pinned state of a note
curl --request POST \
  --url https://client-api.salesfinity.co/v2/notes/{id}/pin \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "user_id": "507f1f77bcf86cd799439011"
}
'
{
  "_id": "507f1f77bcf86cd799439011",
  "team": "507f1f77bcf86cd799439012",
  "author": {
    "_id": "507f1f77bcf86cd799439011",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "image": "<string>"
  },
  "content": "<string>",
  "is_pinned": true,
  "pinned_at": "2023-11-07T05:31:56Z",
  "pinned_by": "<string>",
  "contact": "<string>",
  "company": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.salesfinity.ai/llms.txt

Use this file to discover all available pages before exploring further.

Toggles whether a note is pinned. Pinned notes sort to the top of the list.
Unlike editing and deleting, any team member may toggle a pin — not just the author.

​
Path Parameters

  • id (required, string): Note ID, from List Notes.

​
Request Body

FieldTypeRequiredDescription
user_idstringYesID of the team member toggling the pin. Must be a member of the team that owns the API key.

​
Example Request

{
  "user_id": "507f1f77bcf86cd799439033"
}

​
Response (201)

Returns the updated note object with the new is_pinned, pinned_at, and pinned_by values.

​
Errors

StatusDescription
404Note not found

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

Note ID

Body

application/json
​
user_id
string
required

ID of the team member toggling the pin. Must be a member of the team that owns the API key.

Example:

"507f1f77bcf86cd799439011"

Response

Pin toggled successfully

​
_id
string
Example:

"507f1f77bcf86cd799439011"

​
team
string
Example:

"507f1f77bcf86cd799439012"

​
author
object

Note author. Populated when available; otherwise just the user ID under _id.

​
content
string

Plain text content of the note

​
is_pinned
boolean

Whether this note is pinned to the top

​
pinned_at
string<date-time> | null
​
pinned_by
string | null
​
contact
string | null

Contact this note is attached to (mutually exclusive with company)

​
company
string | null

Company this note is attached to (mutually exclusive with contact)

​
createdAt
string<date-time>
​
updatedAt
string<date-time>