Notes

Create note

Creates a new discussion note for a candidate. Supports visibility control (all or private) and @mentions with email notifications.

post/notes

Request

  • Base URL: https://api.100hires.com/v2
  • URL: https://api.100hires.com/v2/notes
  • Auth: HTTP bearer

Query parameters

includestring

Comma-separated list of related resources to include. Supported: user — author details, candidate — full candidate payload with url_backoffice for UI deep-linking.

Request body

candidate_idstring required

Candidate ID (numeric) or alias

bodystring required

Note content. Supports HTML.

user_idinteger

Author user ID. If omitted, the authenticated user is used

visibilitystring

Visibility: 'all' (default) or 'private'

mention_user_idsinteger[]

Array of user IDs to mention. Mentioned users receive email notifications and their @name or @login references in the body are replaced with HTML mention markup.

Response

Created note

idinteger required

Unique identifier

candidate_idinteger required

ID of the candidate this note belongs to

user_idinteger required

Author user ID (always present)

url_backofficestring uri

Absolute backoffice URL to the candidate's discussion tab where this note appears in the 100Hires recruiter app. Use to render deep-links in agent UIs.

bodystring

Note content (may contain HTML). Mentioned users are wrapped in <span class="mention-area"> markup. Present only when view=full (default); replaced with body_preview when view=summary.

body_previewstring

First 200 UTF-8 characters of the note content with a ... suffix when truncated. Present only when view=summary; replaces body to keep list responses inside the agent context budget.

visibilitystring required

Visibility: 'all' (visible to team) or 'private' (author only)

created_atinteger required

Unix timestamp (seconds)

updated_atinteger required

Unix timestamp (seconds)

Example response

{
  "url_backoffice": "https://app.100hires.com/candidate/dtGeby2#/profile/discussion",
  "candidate": {
    "alias": "dtGeby2",
    "url_backoffice": "https://app.100hires.com/candidate/dtGeby2"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.