Yext Knowledge APIInstall

Summary

Create social media posts for specified entities on a chosen publisher platform via the Yext Knowledge API, supporting multiple media types and scheduling options.

Inputs

• Account Id (required) — The identifier for the Yext account under which the post is created.
• V (required) — API version date in YYYYMMDD format to determine feature set and behavior.
• Entity Ids (required) — A JSON array of entity IDs for which the posts will be created.
• Publisher (required) — The social platform to publish the post to. Options include INSTAGRAM, FACEBOOK, FIRSTPARTY, GOOGLEMYBUSINESS, and LINKEDIN.
• Post Title — Internal title for the post (max 250 characters). If omitted, auto-generated from post text or defaults to "Media Only Post".
• Text — The textual content of the post, respecting character limits per publisher and embedded field formatting based on API version.
• Clickthrough Url — A URL linked in the post, required for Google posts with certain call-to-action types (except CALL).
• Photo Urls — A JSON array of publicly accessible photo URLs (up to 10), enabling multi-image or carousel posts mainly on Facebook and Instagram.
• Videos — A JSON object array describing video content to post; only one video per post is supported for Facebook and Instagram.
• Post Date — Scheduled publish date and time in UTC (format YYYY-MM-DD HH:MM:SS), to post in the future.
• Topic Type — The topic classification of the post, applicable only to Google posts, defaulting to STANDARD. Options are ALERT, EVENT, OFFER, STANDARD.
• Alert Type — Sub-type of alert post used with topicType ALERT, only for Google posts; e.g., COVID_19.
• Offer — Additional JSON data specific to offer-type Google posts.
• Call To Action Type — Defines the action type for Google posts, such as BOOK, CALL, LEARN_MORE, ORDER, or SIGN_UP.
• Event Info — JSON object containing event-specific details required for Google posts of topicType EVENT or OFFER.

Output shape

a single JSON object representing the created post(s) response from Yext Knowledge API

The output includes details of the created post(s) and may reflect scheduled status or errors if any. Pagination is not applicable.

Examples

Example 1: Create an Instagram post with text, photos, and scheduled date for multiple entities.

Set Account Id, V parameter (API version), an array of entity IDs, Publisher to INSTAGRAM, provide post text, photo URLs, and future postDate.