Add a note to a candidate

Add a note to a candidate, optionally about one of their applications, mentioning hiring-team members by user id. Notes are never edited or deleted (they are part of the hiring record) until the candidate's data is erased.

Outcome

Before you start

Verify identity and the pinned organization context, then discover the exact action and a granted Recruit workspace.
The required application permission is workspace:write. Hiring-team roles and record visibility are enforced separately; a workspace grant alone does not grant every Recruit action.
Organization and workspace identity come from verified context. Pass the workspace as resourceType/resourceId, separate from action input; request-body organizationId/workspaceId values cannot select an authorized scope.
The first authorized action can initialize an identity-only workspace mirror and invoke the configured workspace-created callback. It does not create an Auth workspace or grant new access.

Recruiters can perform the full hiring workflow. Hiring managers see their managed roles and candidates; interviewers see assigned interviews and their candidates. Workspace owners and organization administrators act as recruiters. Use team.me to read the caller's effective role and allowed actions.

Discover the target

topolo whoami --json
topolo actions get app_topolo_recruit.candidates.notes.create --detail --json
topolo resources topolo-recruit --json
topolo workspaces list topolo-recruit --json
topolo actions get app_topolo_recruit.team.me --detail --json
topolo actions get app_topolo_recruit.candidates.list --detail --json
topolo actions get app_topolo_recruit.applications.list --detail --json

Request

POST /api/candidates/{id}/notes

Save input as payload.json. CLI and MCP action input includes path identifiers. The reviewed plan separates path/query fields from the HTTP body. Set RECRUIT_WORKSPACE_ID from granted resource discovery.

Inspect and test this action in the signed action console. Use its discovered schema and plan; a test response still requires the verification described below.

Input fields

Field	Required	Type	Constraints
`id`	Required	string	Candidate id from candidates.list. {"minLength":1,"maxLength":64}
`body`	Required	string	{"minLength":1,"maxLength":10000}
`applicationId`	Optional	string	Application id from applications.list in the same workspace. {"minLength":1,"maxLength":64}
`mentions`	Optional	array	{"maxItems":20}

Exact input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "body": {
      "type": "string",
      "minLength": 1,
      "maxLength": 10000
    },
    "applicationId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "mentions": {
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 128
      }
    }
  },
  "required": [
    "id",
    "body"
  ],
  "additionalProperties": false
}

Effects

Creates one note and a timeline entry.

Interpret the response

Call candidates.notes.list and confirm the note.

The response identifier path is $.note.id for note. Lists may be empty; an empty list is not a discovered target.

Exact success schema:

{
  "type": "object",
  "required": [
    "note"
  ],
  "properties": {
    "note": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "candidateId": {
          "type": "string"
        },
        "applicationId": {
          "type": [
            "string",
            "null"
          ]
        },
        "body": {
          "type": "string"
        },
        "mentions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "authorUserId": {
          "type": "string"
        },
        "createdAt": {
          "type": "string"
        }
      }
    }
  }
}

Worked examples

Actual dispatcher and migration-created SQLite or Worker handlers; Auth/workspace identity, object storage, mail and Notify dependencies are simulated. These synthetic fixtures establish no live authorization or delivery. A synthetic fixture identifier grants no access. Validate and inspect the planned request before executing. Commands with --confirm or MCP confirm:true assume the intended effect or data export has already been authorized.

Successful request

Actual dispatcher and migration-created SQLite; verified Auth/workspace context, object storage, mail and Notify dependencies are simulated. No live delivery or credential authorization is established. This complete response is a local fixture, not a deployed or delivered result.

Input · payload.json:

{
  "id": "cand_62ee38ce9eb54716bd78a59ab686fb10",
  "body": "Strong systems thinking"
}

CLI:

topolo actions validate app_topolo_recruit.candidates.notes.create --data @payload.json --json
topolo actions plan app_topolo_recruit.candidates.notes.create --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_recruit.candidates.notes.create --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_recruit.candidates.notes.create",
    "input": {
      "id": "cand_62ee38ce9eb54716bd78a59ab686fb10",
      "body": "Strong systems thinking"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 201:

{
  "note": {
    "id": "note_51301259fc644b6baa0987eedd0072fb",
    "candidateId": "cand_62ee38ce9eb54716bd78a59ab686fb10",
    "applicationId": null,
    "body": "Strong systems thinking",
    "mentions": [],
    "authorUserId": "u_admin",
    "createdAt": "2026-10-05T09:00:00.000Z"
  }
}

HTTP 201. Call candidates.notes.list and confirm the note.

Another supported request

Input · payload.json:

{
  "id": "cand_16181d6f07674ffba717f8aeebdd5a5c",
  "body": "Great"
}

CLI:

topolo actions validate app_topolo_recruit.candidates.notes.create --data @payload.json --json
topolo actions plan app_topolo_recruit.candidates.notes.create --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_recruit.candidates.notes.create --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_recruit.candidates.notes.create",
    "input": {
      "id": "cand_16181d6f07674ffba717f8aeebdd5a5c",
      "body": "Great"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 201:

{
  "note": {
    "id": "note_aae356bf76c14636a2cc38a2cee38e1c",
    "candidateId": "cand_16181d6f07674ffba717f8aeebdd5a5c",
    "applicationId": null,
    "body": "Great",
    "mentions": [],
    "authorUserId": "u_admin",
    "createdAt": "2026-10-05T09:00:00.000Z"
  }
}

HTTP 201. Call candidates.notes.list and confirm the note.

Refused request · not_found

Input · payload.json:

{
  "id": "cand_example",
  "body": "Great system design answers.",
  "mentions": [
    "usr_example"
  ]
}

CLI:

topolo actions validate app_topolo_recruit.candidates.notes.create --data @payload.json --json
topolo actions plan app_topolo_recruit.candidates.notes.create --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 404:

{
  "error": {
    "code": "not_found",
    "message": "Candidate was not found in this workspace."
  }
}

HTTP 404. Preserve the exact response code and details. Do not claim success.

Refused request · hiring_team_role_required

Input · payload.json:

{
  "id": "cand_example",
  "body": "Great system design answers.",
  "mentions": [
    "usr_example"
  ]
}

CLI:

topolo actions validate app_topolo_recruit.candidates.notes.create --data @payload.json --json
topolo actions plan app_topolo_recruit.candidates.notes.create --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 403:

{
  "error": {
    "code": "hiring_team_role_required",
    "message": "Your hiring-team role in this workspace does not allow this action.",
    "details": {
      "teamRole": null,
      "allowedRoles": [
        "recruiter",
        "hiring_manager",
        "interviewer"
      ]
    }
  }
}

HTTP 403. Preserve the exact response code and details. Do not claim success.

Verify the result

Call candidates.notes.list and confirm the note.

Errors and recovery

organization_context_required (HTTP 403): Select the organization authorized by the credential; do not send an organization id in the action input.
permission_denied (HTTP 403): Grant the credential the required Recruit workspace permission.
hiring_team_role_required (HTTP 403): Ask a recruiter to give the caller a hiring-team role that allows this action (team.members.set); error.details lists the allowed roles.
workspace_required (HTTP 409): Create a Recruit workspace, or pass the workspace resource context.
invalid_input (HTTP 422): Correct the fields named in error.details using inputSchema, then retry.
not_found (HTTP 404): List candidates or applications to find a valid id. Records outside the caller's hiring-team view also answer 404.
unknown_mention (HTTP 422): Mention only user ids from team.list.
invalid_json (HTTP 400): Send a valid JSON object. The request is rejected before workspace resolution or record creation.

Authentication or gateway failures may occur before the Recruit handler. Preserve the exact discovered service error, request id and credential context. The local fixtures do not establish live credential authorization.

Recovery boundary

Notes are append-only; add a correcting note.

Evidence

Actual dispatcher and migration-created SQLite or Worker handlers; Auth/workspace identity, object storage, mail and Notify dependencies are simulated. These synthetic fixtures establish no live authorization or delivery. Test capture provenance is retained with each fixture. API, database and integration outcomes require separate verification in the target environment.