Update application form field
update_screening_form_fieldChange one existing field of the application form of a job position: whether it is required, whether an answer outside the expected one disqualifies the candidate (knockout), its expected answer (expectedAnswer), the unit of an amount field (currency + period, both or neither) and, on the address field "neighborhoodLocation" only, the maximum commute distance in kilometres. fieldName is the key in configuration.formSchema.properties of the position's screening configuration, and fieldLabel is that property's title, verbatim; a label that does not match is rejected. A knockout must be a required field with a complete expected answer (on the address field, maxDistanceKm). The base fields firstName, lastName and email are always required. On a professional application, linkedinUrl or resumeFile must stay required: making the only required one of the two optional is rejected. The response reports criteriaVersionChanged: when true, the position's existing scores were computed against the previous form.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"jobDescriptionId": "<jobDescriptionId>",
"fieldName": "<fieldName>",
"fieldLabel": "<fieldLabel>"
},
"name": "update_screening_form_field"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| period | No | Period the amounts cover. Required together with currency. | |
| currency | No | ISO currency code the amounts are expressed in (e.g. USD). Required together with period. | |
| required | No | Whether the candidate must answer this field | |
| fieldName | Yes | Schema key of the field, from configuration.formSchema.properties | |
| fieldLabel | Yes | The title of that property, verbatim. Shown to the user on the confirmation card; a label that does not match the field is rejected. | |
| isKnockout | No | Whether an answer outside the expected one disqualifies the candidate automatically | |
| maxDistanceKm | No | Maximum commute distance in kilometres, for the "neighborhoodLocation" field only. Setting it turns the expected answer on. | |
| expectedAnswer | No | The expected answer. Setting it turns the expectation on. A knockout also needs the field to be required. | |
| jobDescriptionId | Yes | The job position ID | |
| expectedAnswerEnabled | No | Whether the expected answer of this field is applied at all. Pass false to stop applying it while keeping the configured value; it also clears the knockout. |