Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Yext Social API

The Social API from Yext — 10 operation(s) for social.

Yext Social API is one of 23 APIs that Yext publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Social. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 15 operations across 10 paths, and defines 20 schemas. It is described by OpenAPI 3.0.0, at version 2.0.

Requests are made against a single base URL, https://api.yextapis.com/v2.

15 operations 10 paths 20 schemas 3 DELETE6 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0
Base URL
https://api.yextapis.com/v2
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Yext Social API declares 2 security schemes for authenticating requests. An API key is passed in the query as api_key (api_key). An API key is passed in the header as api-key (api-key). By default, every request must be authenticated.

Paths & Operations 15

Across 10 paths, the API surfaces 15 operations — 3 DELETE, 6 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Social 15
GET
/accounts/{accountId}/posts
Posts: List
listPosts 10 params → 200default
POST
/accounts/{accountId}/posts
Post: Create
createPosts 3 params body → 200default
GET
/accounts/{accountId}/posts/{postId}
Post: Get
getPost 4 params → 200default
PUT
/accounts/{accountId}/posts/{postId}
Post: Update
updatePost 4 params body → 200default
DELETE
/accounts/{accountId}/posts/{postId}
Post: Delete
deletePost 4 params → 200default
POST
/accounts/{accountId}/posts/generatePostText
Post: Generate Text
generatePostText 2 params body → 200default
DELETE
/accounts/{accountId}/entityPosts/{entityPostId}
Entity Post: Delete
deleteEntityPost 3 params → 200default
POST
/accounts/{accountId}/entityPosts/{entityPostId}/comments
Comment: Create
createEntityPostComment 3 params body → 200default
GET
/accounts/{accountId}/entityPosts/{entityPostId}/comments
Entity Post: Comments
getEntityPostComments 4 params → 200default
DELETE
/accounts/{accountId}/entityPosts/{entityPostId}/comments/{commentId}
Comment: Delete
deleteEntityPostComment 4 params → 200default
POST
/accounts/{accountId}/social/video
Video: Upload
uploadVideo 2 params body → 200default
GET
/accounts/{accountId}/social/eligibility
Eligibility: Get
socialEligibility 4 params → 200default
GET
/accounts/{accountId}/social/conversation
Conversation: Get
getSocialConversation 6 params → 200default
GET
/accounts/{accountId}/social/messages
Messages: List
listSocialMessages 11 params → 200default
POST
/accounts/{accountId}/social/messages
Messages: Create
createSocialMessages 3 params body → 200default

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are Post (17 properties), CreatePost (14 properties), Message (13 properties), ConversationMessageWithParent (10 properties). Each schema is shown below with its type and property counts.

Entity
object
The entity which the post is for.
1 property
UploadVideo
object
4 properties 4 required
Message
object
13 properties
ResponseMetaWithError
NextPageToken
string
This field is only included if there is an additional page of data to display. To retrieve the next page of data, pass this field's value as the pageToken para…
ConversationMessage
object
9 properties
GeneratePostText
object
CreatePost
object
14 properties 2 required
EntityPost
object
7 properties
CommentWithReplies
EntityPostStatus
object
The status of the post.
2 properties
ConversationMessageWithParent
object
10 properties
UpdatePost
object
7 properties
Comment
object
7 properties
EventInfo
object
Event information. Required for topicType EVENT and OFFER. Only supported on Google posts.
3 properties 3 required
Offer
object
Additional data for offer posts. Only supported on Google posts.
3 properties
Post
object
17 properties
Metrics
object
The metrics for the entity post.
9 properties
ResponseMeta
object
1 property
ResponseError
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yext-social-api-openapi.yml Raw ↑

Other APIs Yext publishes across the network.

Yext Account Settings API
Yext Accounts API
Yext Administrative API API
Yext Analytics API
Yext Computations API
Yext Configuration API
Yext Connectors API
Yext Content API API
Yext Domains API
Yext Health Check API
Yext Knowledge Manager API
Yext Licenses API