Yext Knowledge API icon

Yext Knowledge API

Interact with Yext Knowledge API

Actions176

Social → Update Post

AI-generated

Summary

Update an existing social post on a specified Yext account by modifying its content and related metadata.

Inputs

  • Account Id (required) — The ID of the Yext account that owns the post to update.
  • V (required) — The version date in YYYYMMDD format for indexing the API.
  • Post Id (required) — The unique identifier of the social post to update.
  • Text — The updated copy text for the post.
  • Photo Urls — A JSON array of publicly accessible photo URLs for the post; currently only one photo is supported.
  • Alert Type — Specifies the alert subtype if the post is of topicType ALERT; options include UNSPECIFIED or COVID 19.
  • Offer — Additional offer-related data as JSON, applicable to Google posts.
  • Call To Action Type — Defines the action type on the post, such as BOOK, CALL, LEARN MORE, ORDER, or SIGN UP; required if clickthrough URL is provided and the post is on Google.
  • Clickthrough Url — URL linked from the post for user clickthrough.
  • Event Info — Event-related information as JSON, required for topicType EVENT and OFFER posts, supported only on Google posts.

Output shape

a single JSON object representing the updated social post as returned by the Yext Knowledge API

The operation requests and returns a single updated post object. The API version is specified via the v query parameter. Optional fields may be omitted if not needed. Any invalid JSON in JSON fields will result in error.

Examples

Example 1: Update the text and add a photo URL to a specific social post on a Yext account.

Provide Account Id, version date (v), Post Id, updated Text, and Photo Urls as JSON array with one URL.

Discussion