Create note
hires_create_noteCreate a discussion note for a candidate. Supports visibility control (all or private) and @mentions with email notifications. Always pass include=candidate when surfacing results in the widget — without it, the confirmation card can only show the candidate ID and cannot link to their backoffice profile.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Note content. Supports HTML. | |
| include | No | Include related resources, e.g. 'user' for author details, 'candidate' for full candidate object with url_backoffice. Set to `candidate` so the widget can link the candidate name to their backoffice profile. | |
| user_id | No | Author user ID. If omitted, the authenticated user is used | |
| visibility | No | Visibility: 'all' (default) or 'private' | |
| candidate_id | Yes | Candidate ID (numeric) or alias | |
| mention_user_ids | No | Array of user IDs to mention. Mentioned users receive email notifications. |