Actions176
- Health Check Actions
- Knowledge Manager Actions
- List Entities
- Create Entity
- Get Entity
- Update Entity
- Delete Entity
- List Language Profiles
- List All Language Profiles
- Get Language Profile
- Upsert Language Profile
- Delete Language Profile
- Get Locations
- Create Location
- Search Locations
- Get Location
- Update Location
- Get Location Folders
- Get Menus
- Create Menu
- Get Menu
- Update Menu
- Delete Menu List
- Get Bios
- Create Bio
- Get Bio
- Update Bio
- Delete Bio List
- Get Products
- Create Product
- Get Product
- Update Product
- Delete Product List
- Get Events
- Create Event
- Get Event
- Update Event
- Delete Event List
- Get Business Categories
- Get Google Keywords
- Get Custom Fields
- Create Custom Field
- Get Custom Field
- Update Custom Field
- Delete Custom Field
- Get Language Profiles
- Get Location Language Profile
- Upsert Location Language Profile
- Delete Location Language Profile
- List Assets
- Create Asset
- Get Asset
- Update Asset
- Delete Asset
- Upsert Suggestion
- List Suggestions
- Cancel Suggestion
- Get Suggestion
- Comment Suggestion
- Update Suggestion
- Listings Actions
- List Publishers
- List Listings
- Opt In Listings
- Opt Out Listings
- Confirm Sync Listings
- Force Sync Listings
- List Publisher Suggestions
- Get Publisher Suggestion
- Update Publisher Suggestion
- List Duplicates
- Create Duplicate
- Delete Duplicate
- Suppress Duplicate
- List Methods
- List Statuses
- Initiate Verification
- Complete Verification
- List Admins
- Invite Admins
- List Entity Listings
- Delete Listings
- List Questions
- Get Question
- Create Answer
- Update Answer
- Delete Answer
- Analytics Actions
- Logs API Actions
- Reviews Actions
- Social Actions
- Account Settings Actions
- Optimization Tasks Actions
- Connectors Actions
- Configuration Actions
- Licenses Actions
- Computations Actions
- Domains Actions
Knowledge Manager → Update Custom Field
AI-generatedSummary
Update a Custom Field in the Yext Knowledge Manager by specifying its name, group, description, options (if applicable), language behavior, validation rules, and entity availability.
Inputs
- Name (required) — The JSON object representing the Custom Field's name with default value and optional translations for multiple languages.
- Options — A JSON array of options with keys, values, and translations, relevant only if the Custom Field type is SINGLE_OPTION or MULTI_OPTION; existing options not included will be deleted, specified keys update options, and specifying value without a key adds a new option.
- Group — The group to which the Custom Field belongs, selected from predefined groups (NONE to GROUP_30).
- Description — A JSON object for the Custom Field's description and optional translations; shown as a tooltip in the Knowledge Manager.
- Alternate Language Behavior — Defines multi-language profile behavior: PRIMARY_ONLY, OVERRIDABLE, or LANGUAGE_SPECIFIC.
- Validation — A JSON object describing validation rules for setting or updating values of the Custom Field.
- Entity Availability — A JSON array of entity types indicating where the Custom Field is available.
Output shape
a single JSON object representing the updated Custom Field
The operation returns the updated Custom Field object as received from the Yext Knowledge API. Inputs must be JSON-stringified for fields like name, description, options, validation, and entityAvailability. Options handling in updates can delete unspecified existing options.