create_custom_field
Create a new custom field definition for candidates, applications, jobs, offers, openings, or users. Use it to add admin-only fields for tracking extra hiring data.
Instructions
Create a new custom field definition. Write operation — admin only.
Defines a new field available on candidates, applications, jobs, offers, openings or users.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Display name for the custom field | |
| options | No | Initial dropdown options for select fields: [{name, sort_order}] | |
| private | No | If true, only visible to users with private field access | |
| field_type | Yes | Entity: candidate, application, job, offer, opening, user_attribute | |
| value_type | Yes | short_text, long_text, yes_no, single/multi_select, currency, date, number, url, user, currency_range, number_range | |
| description | No | Helper text shown beneath the field label | |
| generate_email_token | No | If true, generates an email token for this field |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |