Yext Knowledge API icon

Yext Knowledge API

Interact with Yext Knowledge API

Actions176

Social → Social Eligibility

AI-generated

Summary

Check the social eligibility of specified entities on given social media publishers within a specified Yext account and date version.

Inputs

  • Account Id (required) — The Yext account identifier to check eligibility against.
  • V (required) — The version date for the request in YYYYMMDD format.
  • Publishers (required) — A JSON array of social media publishers to verify eligibility for.
  • Entity Ids (required) — A JSON array of entity IDs to check social eligibility for.

Output shape

a JSON response from the Yext Knowledge API indicating eligibility status per entity and publisher

The response shape depends on the Yext API and may contain eligibility details per entity ID and publisher provided. Requests use query parameters, and batching can be configured via Request Options to throttle large inputs.

Discussion