Skip to main content
POST
Toggle pinned state of a note
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

Example Request

Response (201)

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

Errors

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>