Yext Knowledge API icon

Yext Knowledge API

Interact with Yext Knowledge API

Actions176

Knowledge Manager → Delete Entity

AI-generated

Summary

Delete a specified entity from a Yext Knowledge Manager account by providing its external Entity ID and the required date version parameter.

Inputs

  • Account Id (required) — The identifier of the Yext account from which the entity will be deleted.
  • Entity Id (required) — The external ID of the entity to delete.
  • V (required) — A version date string in YYYYMMDD format to specify the API version to use for the request.
  • Update Operation Id — Optional. The ID of an existing update operation to continue; leave blank to create a new operation.
  • Request Options — Optional settings such as batching, SSL validation ignoring, proxy configuration, and timeout to control the request behavior.

Output shape

a single response confirming the deletion operation result, typically the deleted entity details or status response from the Knowledge API

The output shape exactly corresponds to the Knowledge API response from the delete entity call. If batching is enabled in request options, multiple deletions can be performed sequentially with throttling. Errors or failures will be returned according to API error format.

Discussion