Generated by API Evangelist
Written by API Evangelist tooling for KEBA's API. It is a proposal applied on top of the contract, not a document KEBA publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for eRecruiter Applicant Custom Field API
version: 1.0.0
extends: openapi/keba-applicantcustomfield-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-11-20'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/Api/Applicant/{applicantId}/CustomField/{customFieldName}'].get
update:
x-apievangelist-phrasing:
intent: Get a custom field value for an applicant
effect: read
questions:
- What is the value of a custom field on an applicant's profile?
- Can I read one custom field by its internal name?
instructions:
- text: Get custom field {customFieldName} for applicant {applicantId}.
slots:
customFieldName: path.customFieldName
applicantId: path.applicantId
- text: Show the value of {customFieldName} on applicant {applicantId}.
slots:
customFieldName: path.customFieldName
applicantId: path.applicantId
method: generated
generated: '2026-11-20'
- target: $.paths['/Api/Applicant/{applicantId}/CustomField/{customFieldName}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a custom field value from an applicant
effect: destructive
questions:
- How do I clear a custom field value from an applicant's profile?
- Can I remove one custom field value without deleting the field definition?
instructions:
- text: Delete custom field {customFieldName} from applicant {applicantId}.
slots:
customFieldName: path.customFieldName
applicantId: path.applicantId
- text: Clear the {customFieldName} value on applicant {applicantId}.
slots:
customFieldName: path.customFieldName
applicantId: path.applicantId
method: generated
generated: '2026-11-20'
- target: $.paths['/Api/Applicant/{applicantId}/CustomField'].post
update:
x-apievangelist-phrasing:
intent: Set a custom field value on an applicant
effect: write
questions:
- How do I set a custom field value on an applicant?
- Can I store a list of values in a checkbox custom field?
instructions:
- text: Set custom field {CustomField} to {Value} for applicant {applicantId}.
slots:
CustomField: requestBody.CustomField
Value: requestBody.Value
applicantId: path.applicantId
- text: Save checkbox values {Values} in custom field {CustomField} for applicant {applicantId}.
slots:
Values: requestBody.Values
CustomField: requestBody.CustomField
applicantId: path.applicantId
method: generated
generated: '2026-11-20'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. By signing up you are subscribing to the APIs.io and API Evangelist
newsletters — you can unsubscribe from any issue. See our
Privacy Policy and Terms.