Yext Knowledge APIInstall

Summary

Update an existing entity in a Yext Knowledge Manager account by specifying the account ID, entity ID, and version date, optionally applying a template and controlling rich text formatting options.

Inputs

• Account Id (required) — The ID of the Yext account containing the entity to update.
• Entity Id (required) — The external ID of the entity to update.
• V (required) — The version date of the request in YYYYMMDD format.
• Update Operation Id — ID of the update operation; leave blank to create a new operation or specify to continue an existing one.
• Format — Formatting language (markdown or html) for parsing rich text fields; required if the update contains rich text fields.
• Strip Unsupported Formats — When true, unsupported rich text formats are stripped and saved as plain text; otherwise, unsupported formats cause errors.
• Template Fields — Comma-separated top-level fields from the template to apply; only used if a template ID is provided.
• Template Id — External ID of a template to apply to the entity, applying fields and linked accounts from that template.
• Entity Type — Entity type to include in the request body meta object; used to filter fields and should not be sent as a query parameter.

Output shape

a single JSON object representing the updated entity or operation result

Responses include standard JSON bodies from the Yext Knowledge API update entity endpoint; batching and retry settings can be configured via node settings but pagination is not applicable.

Examples

Example 1: Update the address and phone number of a location entity using its entity ID, specifying the account and version date, and applying markdown formatting for rich text fields.

Set Account Id, Entity Id, V, Format as 'markdown', and provide the fields to update in the node's input data.