Yext Knowledge API icon

Yext Knowledge API

Interact with Yext Knowledge API

Actions176

Social → Create Social Messages

AI-generated

Summary

Create a new social message associated with a specified entity in a Yext account and publish it to a selected social media platform (Facebook or Instagram).

Inputs

  • Account Id (required) — The identifier of the Yext account where the social message will be created.
  • V (required) — The API version date in YYYYMMDD format used as a query parameter.
  • Entity Id (required) — The ID of the entity (e.g., location) the social message is created for.
  • Publisher (required) — Select the social media platform to publish the message to, either FACEBOOK or INSTAGRAM.
  • User Id (required) — The user ID on the selected publisher platform that the message should be sent to.
  • Text (required) — The content text of the social message to be sent. Note: Facebook supports up to 2000 characters; Instagram supports up to 1000 characters.
  • Page Token — Optional token to retrieve the next page of data if the prior request provided a nextPageToken; sent as a query parameter.
  • Request Options — Optional settings such as batching detail, proxy configuration, SSL certificate validation behavior, and request timeout to customize API request handling.

Output shape

a single record containing the response from the Yext API after creating the social message.

The operation returns the created social message details in JSON format. Pagination may be handled via the optional Page Token. Requests are authenticated via configured Yext credentials.

Discussion