Yext Knowledge API icon

Yext Knowledge API

Interact with Yext Knowledge API

Actions176

Listings → Force Sync Listings

AI-generated

Summary

Trigger an immediate synchronization of Listings data for specified locations and publishers within your Yext account.

Inputs

  • Location Ids — A JSON array of location IDs to sync. Defaults to all account locations with a Listings subscription if not provided. Example: ["loc123", "loc456", "loc789"]
  • Publisher Ids — A JSON array of publisher IDs to sync. Defaults to all publishers subscribed by the account if not provided. Example: ["MAPQUEST", "FACEBOOK"]
  • Request Options — Optional settings for the HTTP request, including batching parameters (items per batch and interval between batches), SSL certificate validation bypass, proxy configuration, and request timeout in milliseconds.

Output shape

a single JSON response from Yext API confirming the forced synchronization request or containing error details

The output corresponds to the API response from Yext's Listings force sync endpoint. Batch options control request throttling if multiple location or publisher IDs are specified.

Discussion