Add a note
Add a note to a candidate's application, or to one of their workflow steps (stageId) or Activity Runs (activityRunRef). Everyone on the Job's team can read it.
POST
bearerheader
AuthorizationBearer <API key or OAuth token>An organization API key (ink_live_…, ADR-0124), or the OAuth access token a person's AI client gets from the Recruiter MCP sign-in. Only the Authorization header is accepted.
Idempotency-Key?stringMakes a write safe to repeat: the same key and input return the first result. Required for agents' writes and for anything a person confirms.
Match
^[A-Za-z0-9._:-]+$Length
8 <= length <= 128application/json- body
input*confirmation?stringThe id from a confirm or awaiting_approval Outcome, sent with the same input and key to go ahead.
Done. A replay of the same key and input omits output.
application/json- response
status*unknownoutput?replay?actionId*stringcurl -X POST 'https://www.invyte.ai/api/recruiter/v1/operations/notes.add' \ -H 'Content-Type: application/json' \ -d '{ "input": { "applicationId": "string", "content": "string" }}'Example Response
{ "status": "done", "output": { "noteId": "string" }, "replay": { "noteId": "string" }, "actionId": "string"}