Yext Knowledge APIInstall

Summary

Delete listings in the Yext Knowledge API by specifying entity IDs and optionally filtering by publisher IDs.

Inputs

• Entity Ids — A JSON array of entity IDs to delete listings for. If omitted, defaults to all account events with a subscription. Example: ["entity123","entity456","entity789"]
• Publisher Ids — A JSON array of publisher IDs to restrict the deletion to specific publishers. If omitted, defaults to all publishers subscribed by the account. Example: ["FACEBOOKEVENTS","EVENTBRITE"]
• Request Options — Additional request options including batching (items per batch and batch interval in milliseconds), handling of SSL certificate validation, HTTP proxy configuration, and request timeout in milliseconds.

Output shape

a JSON object confirming deletion status for each requested entity and publisher combination

The operation supports batching to throttle deletion requests. The response details may vary depending on which entities and publishers are specified and the server response; errors are returned according to the Yext API's conventions.

Examples

Example 1: Delete listings for specified entities across all subscribed publishers

Provide a JSON array of entity IDs with no publisher IDs specified.

Example 2: Delete listings for specified entities but only for certain publishers

Provide JSON arrays for both entity IDs and publisher IDs to restrict the scope.