Yext Knowledge API icon

Yext Knowledge API

Interact with Yext Knowledge API

Actions176

Knowledge Manager → Upsert Suggestion

AI-generated

Summary

Upsert a field suggestion for a single entity in the Yext Knowledge Manager by providing structured suggestion details.

Inputs

  • Account Id (required) — The identifier for the Yext account under which to upsert the suggestion.
  • V (required) — API version date in YYYYMMDD format to specify the version of the API to use.
  • Format — The formatting language for parsing rich text fields; can be 'markdown', 'html', or 'none' (defaults to 'markdown').
  • Entity Field Suggestion (required) — A JSON object containing detailed information about the suggested content for a single field on an entity. This includes entity details and suggested content such as address, hours, photos, FAQs, keywords, and various other attribute fields relevant to the suggestion.

Output shape

a single JSON object representing the API response to the upsert suggestion request

The output contains the response from the Yext Knowledge Manager API after attempting to upsert the suggestion. The operation respects batching options if enabled, and supports additional request options like proxy usage, request timeouts, and SSL certificate validation ignoring.

Discussion