Skip to main content

coach_notes.update

Reword a note already left on an application

Request
PATCH/api/v1/organizations/{organizationSlug}/coach-notes/{noteId}
Scope required
coach_notes:write
Effect
Changes data. Send an Idempotency-Key if you might retry it.
Acts on
Acts on an organization, and names it in the path.
MCP tool
coach_notes_update
Environment
Live and sandbox alike.
Request body
JSON.

What it does

Replaces the body of an existing note. The author may edit their own, and an owner or admin of the note's organization may edit anybody's; everyone else is told the note does not exist. The applicant can already see it, so an edit corrects the record rather than hiding anything — to take a note back, delete it with `coach_notes.delete`. The note is addressed through the organization that owns it, so a credential confined to one organization can only reach its own notes.

Parameters

Parameters this endpoint accepts, where each one goes, and whether it is required
NameSent inRequirementAccepts
organizationSlugpathRequiredstring
noteIdpathRequiredstring

Request body

body
string, required

Response

applicationId
string, required
authorDisplayName
string or null, required
body
string, required
createdAt
string, required
id
string, required
organization
object, required
name
string, required
slug
string, required
updatedAt
string, required

Examples

Correct a note

Correct a note — request
curl -s -X PATCH https://www.jobapplicationtracking.com/api/v1/organizations/northside-career-center/coach-notes/note_54 \
  -H "Authorization: Bearer $JAT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "Ask them about the take-home before Thursday."
}'
Correct a note — response
{
  "id": "note_54",
  "applicationId": "app_123",
  "body": "Ask them about the take-home before Thursday.",
  "authorDisplayName": "Dana Reyes",
  "organization": {
    "slug": "northside-career-center",
    "name": "Northside Career Center"
  },
  "createdAt": "2026-02-11T17:05:00.000Z",
  "updatedAt": "2026-02-11T17:05:00.000Z"
}

Related operations