coach_notes.delete

Take back a note left on an application

Request: DELETE/api/v1/organizations/{organizationSlug}/coach-notes/{noteId}
Scope required: coach_notes:write
Effect: Deletes something. Confirm with a person before calling it.
Acts on: Acts on an organization, and names it in the path.
MCP tool: coach_notes_delete
Environment: Live and sandbox alike.
Request body: JSON.

What it does

Deletes a note. The author may delete their own, and an owner or admin of the note's organization may delete anybody's; everyone else is told the note does not exist. This cannot be undone, and the applicant may already have read it. The note is addressed through the organization that owns it, so a credential confined to one organization can only reach its own notes. Answers 204 with no body. To correct a note rather than lose it, use `coach_notes.update`.

Parameters

Parameters this endpoint accepts, where each one goes, and whether it is required
Name	Sent in	Requirement	Accepts
organizationSlug	path	Required	string
noteId	path	Required	string

Response

Answers 204 with no body.

Examples

Remove a note written on the wrong card

Remove a note written on the wrong card — request

curl -s -X DELETE https://www.jobapplicationtracking.com/api/v1/organizations/northside-career-center/coach-notes/note_54 \
  -H "Authorization: Bearer $JAT_KEY"

Remove a note written on the wrong card — response

null