Change or pin a note

PATCH

/api/workspaces/{ws}/hires/{id}/notes/{nid}

PATCH

/api/workspaces/{ws}/hires/{id}/notes/{nid}

Authorization

session

cookiebetter-auth.session_token<token>

Set by POST /api/auth/sign-in/email.

Path Parameters

ws*string

The workspace id (from GET /api/me).

id*string

The id of what the path names: a hire, a connection, a skill, a shared file, a department, a position, a goal or an approval.

nid*string

The note's id.

Request Body

application/json

body

text?string

Length1 <= length <= 2000

pinned?boolean

Response Body

The note.

application/json

Example Request

curl -X PATCH 'https://app.useroster.work/api/workspaces/string/hires/string/notes/string' \
  -H 'Content-Type: application/json' \
  -d '{}'

Example Request

curl -X PATCH 'https://app.useroster.work/api/workspaces/string/hires/string/notes/string' \  -H 'Content-Type: application/json' \  -d '{}'

Example Response

{
  "id": "5a6b7c8d-1e2f-4a3b-8c9d-0e1f2a3b4c5d",
  "text": "Release notes go in #releases, never in #general.",
  "pinned": false,
  "createdAt": "2026-11-03T09:00:00.000Z"
}

{  "id": "5a6b7c8d-1e2f-4a3b-8c9d-0e1f2a3b4c5d",  "text": "Release notes go in #releases, never in #general.",  "pinned": false,  "createdAt": "2026-11-03T09:00:00.000Z"}

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Path Parameters

Request Body

Response Body