Yext Knowledge APIInstall

Summary

Update an existing asset in Yext Knowledge Manager by specifying its ID and providing new values for properties such as name, type, and associations with entities.

Inputs

• Id — Unique alphanumeric ID of the asset assigned by Yext to identify the asset to update.
• Name (required) — New name to assign to the asset.
• Type (required) — Type of the asset; can be a standard or custom field type.
• For Entities (required) — JSON object specifying entity and label IDs the asset is associated with.
• Usage (required) — JSON array defining how the asset is used, including relevant field names.
• Format (required) — Format used to parse rich text fields; either 'markdown' or 'html'.
• Description — Optional description for the asset.
• Locale — Language locale of the asset.
• Labels — JSON array of text labels assigned to the asset.
• Owner — ID of the user who owns the asset.

Output shape

a single updated asset record as returned by the Yext API

The output contains the updated asset details. The operation requires the asset ID and mandatory fields; optional fields can be omitted. The format query parameter applies only when updating rich text fields.

Examples

Example 1: Update an asset's name and type

Set 'Id' to target the asset, provide new 'Name', specify 'Type', and required 'For Entities' and 'Usage' JSON arrays.