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 → Create Custom Field
AI-generatedSummary
Create a new custom field in Yext Knowledge Manager by providing the field definition as a JSON body.
Inputs
- Body (required) — The JSON string representing the custom field definition to create; parseable to a JSON object sent as the request body.
- Request Options — Optional settings for request handling, including batching parameters (items per batch and batch interval), SSL certificate validation bypass, proxy configuration, and timeout duration in milliseconds.
Output shape
a single JSON object representing the created custom field
The output returns the API response with the details of the created custom field; batching and other request options affect the sending behavior but not output shape.
Examples
Example 1: Create a text custom field for location entity.
Set 'Body' to a JSON string defining the custom field schema, e.g., {"name":"customField1", "type":"TEXT", "label":"Custom Field 1"}, optionally configure 'Request Options' for batching or timeout.