Posts: List
Retrieve Social Posts made in the past six months matching the given criteria.
path Parameters
| accountId required | string |
query Parameters
| v required | string A date in |
| pageToken | string If a response to a previous request contained the nextPageToken field, pass that field's value as the pageToken parameter to retrieve the next page of data. |
| postIds | Array of strings Only return posts with the postIDs in the specified list. |
| entityPostIds | Array of strings Only return entityPosts with entityPostIds in the specified list. |
| entityIds | Array of strings Only return posts for the specified entities. |
| publishers | Array of strings Items Enum: "INSTAGRAM" "FACEBOOK" "FIRSTPARTY" "GOOGLEMYBUSINESS" Only return posts on the specified publishers. |
| text | string Only return posts with the specified text. |
| status | Array of strings Only include posts which match one of the specified statuses:
|
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "posts": [
- {
- "postId": "string",
- "entityId": [
- "string"
], - "publishers": [
- "string"
], - "text": "string",
- "photoUrls": [
- "string"
], - "topicType": "string",
- "alertType": "string",
- "offer": {
- "couponCode": "string",
- "redeemOnlineUrl": "string",
- "termsConditions": "string"
}, - "clickthroughUrl": "string",
- "callToActionType": "string",
- "eventInfo": {
- "title": "string",
- "startTime": "string",
- "endTime": "string"
}, - "createdDate": "string",
- "postDate": "string",
- "postCreatedInYext": true,
- "entityPosts": [
- {
- "entityPostId": "string",
- "entity": {
- "id": "string"
}, - "publisher": "INSTAGRAM",
- "status": {
- "status": "POST_SCHEDULED",
- "details": "string"
}, - "metrics": {
- "viewCount": 0,
- "uniqueViewCount": 0,
- "clickCount": 0,
- "likeCount": 0,
- "loveCount": 0,
- "wowCount": 0,
- "hahaCount": 0,
- "sadCount": 0,
- "angerCount": 0
}, - "comments": [
- {
- "commentId": "string",
- "parentCommentId": "string",
- "authorName": "string",
- "text": "string",
- "hidden": true,
- "likes": 0,
- "createdTimestamp": true,
- "replies": [
- {
- "commentId": null,
- "parentCommentId": null,
- "authorName": null,
- "text": null,
- "hidden": null,
- "likes": null,
- "createdTimestamp": null
}
]
}
]
}
]
}
], - "nextPageToken": "string"
}
}Post: Create
Create a new social post.
path Parameters
| accountId required | string |
query Parameters
| v required | string A date in |
Request Body schema: application/json
| entityIds required | Array of strings ID(s) of the entities to post for |
| publisher required | string Enum: "INSTAGRAM" "FACEBOOK" "FIRSTPARTY" "GOOGLEMYBUSINESS" "LINKEDIN" The publisher the post should be sent to. |
| requiresApproval | boolean Whether or not the post(s) must be manually approved within Yext. Defaults to false. |
| text | string The copy to be featured on the post. Character limits vary per publisher. Please refer to the following character limits:
|
| clickthroughUrl | string Url included with the post. Required for Google posts that include a callToActionType except CALL |
| photoUrls | Array of strings List of publicly accessible URLs where the photos can be retrieved from. NOTE: Currently supports up to 10 photo urls to create multi-image and carousel posts on Facebook and Instagram. |
| postDate | string If the post should be scheduled for some time in the future, specify a postDate in the
future here. Formatted as datetime in |
| topicType | string Enum: "ALERT" "EVENT" "OFFER" "STANDARD" The topicType of the post. Only supported on Google posts. Defaults to |
| alertType | string Enum: "ALERT_TYPE_UNSPECIFIED" "COVID_19" The type of alert the post is created for. NOTE: This field is only applicable for posts of
topicType |
object Additional data for offer posts. Only supported on Google posts. | |
| callToActionType | string Enum: "BOOK" "CALL" "LEARN_MORE" "ORDER" "BUY" "SIGN_UP" The actionType of the post. Only supported on Google posts. |
object Event information. Required for topicType |
Responses
Request samples
- Payload
{- "entityIds": [
- "string"
], - "publisher": "INSTAGRAM",
- "requiresApproval": true,
- "text": "string",
- "clickthroughUrl": "string",
- "photoUrls": [
- "string"
], - "postDate": "string",
- "topicType": "ALERT",
- "alertType": "ALERT_TYPE_UNSPECIFIED",
- "offer": {
- "couponCode": "string",
- "redeemOnlineUrl": "string",
- "termsConditions": "string"
}, - "callToActionType": "BOOK",
- "eventInfo": {
- "title": "string",
- "startTime": "string",
- "endTime": "string"
}
}Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "postId": "string",
- "entityId": [
- "string"
], - "publishers": [
- "string"
], - "text": "string",
- "photoUrls": [
- "string"
], - "topicType": "string",
- "alertType": "string",
- "offer": {
- "couponCode": "string",
- "redeemOnlineUrl": "string",
- "termsConditions": "string"
}, - "clickthroughUrl": "string",
- "callToActionType": "string",
- "eventInfo": {
- "title": "string",
- "startTime": "string",
- "endTime": "string"
}, - "createdDate": "string",
- "postDate": "string",
- "postCreatedInYext": true,
- "entityPosts": [
- {
- "entityPostId": "string",
- "entity": {
- "id": "string"
}, - "publisher": "INSTAGRAM",
- "status": {
- "status": "POST_SCHEDULED",
- "details": "string"
}, - "metrics": {
- "viewCount": 0,
- "uniqueViewCount": 0,
- "clickCount": 0,
- "likeCount": 0,
- "loveCount": 0,
- "wowCount": 0,
- "hahaCount": 0,
- "sadCount": 0,
- "angerCount": 0
}, - "comments": [
- {
- "commentId": "string",
- "parentCommentId": "string",
- "authorName": "string",
- "text": "string",
- "hidden": true,
- "likes": 0,
- "createdTimestamp": true,
- "replies": [
- {
- "commentId": "string",
- "parentCommentId": "string",
- "authorName": "string",
- "text": "string",
- "hidden": true,
- "likes": 0,
- "createdTimestamp": true
}
]
}
]
}
]
}
}Post: Get
Retrieve a specific social post.
path Parameters
| accountId required | string |
| postId required | string The ID of a specific post. |
query Parameters
| v required | string A date in |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "postId": "string",
- "entityId": [
- "string"
], - "publishers": [
- "string"
], - "text": "string",
- "photoUrls": [
- "string"
], - "topicType": "string",
- "alertType": "string",
- "offer": {
- "couponCode": "string",
- "redeemOnlineUrl": "string",
- "termsConditions": "string"
}, - "clickthroughUrl": "string",
- "callToActionType": "string",
- "eventInfo": {
- "title": "string",
- "startTime": "string",
- "endTime": "string"
}, - "createdDate": "string",
- "postDate": "string",
- "postCreatedInYext": true,
- "entityPosts": [
- {
- "entityPostId": "string",
- "entity": {
- "id": "string"
}, - "publisher": "INSTAGRAM",
- "status": {
- "status": "POST_SCHEDULED",
- "details": "string"
}, - "metrics": {
- "viewCount": 0,
- "uniqueViewCount": 0,
- "clickCount": 0,
- "likeCount": 0,
- "loveCount": 0,
- "wowCount": 0,
- "hahaCount": 0,
- "sadCount": 0,
- "angerCount": 0
}, - "comments": [
- {
- "commentId": "string",
- "parentCommentId": "string",
- "authorName": "string",
- "text": "string",
- "hidden": true,
- "likes": 0,
- "createdTimestamp": true,
- "replies": [
- {
- "commentId": "string",
- "parentCommentId": "string",
- "authorName": "string",
- "text": "string",
- "hidden": true,
- "likes": 0,
- "createdTimestamp": true
}
]
}
]
}
]
}
}Post: Update
Update a social post.
NOTE: Updates are only allowed for posts with no entity posts currently processing. Entity posts that failed to publish will not be updated by subsequent requests to the update endpoint. Updates to Google Posts may not be reflected immediately.
path Parameters
| accountId required | string |
| postId required | string The ID of a specific post. |
query Parameters
| v required | string A date in |
Request Body schema: application/json
| text | string The copy to be featured on the post. |
| photoUrls | Array of strings List of publicly accessible URLs where the photos can be retrieved from. NOTE: Currently only supports one photo. |
| alertType | string Enum: "ALERT_TYPE_UNSPECIFIED" "COVID_19" The type of alert the post is created for. This field is only applicable for posts of
topicType |
object Additional data for offer posts. Only supported on Google posts. | |
| callToActionType | string Enum: "BOOK" "CALL" "LEARN_MORE" "ORDER" "BUY" "SIGN_UP" The actionType of the post. Required for Google posts that include a clickthroughUrl. |
| clickthroughUrl | string The clickthrough URL included with the post. |
object Event information. Required for topicType |
Responses
Request samples
- Payload
{- "text": "string",
- "photoUrls": [
- "string"
], - "alertType": "ALERT_TYPE_UNSPECIFIED",
- "offer": {
- "couponCode": "string",
- "redeemOnlineUrl": "string",
- "termsConditions": "string"
}, - "callToActionType": "BOOK",
- "clickthroughUrl": "string",
- "eventInfo": {
- "title": "string",
- "startTime": "string",
- "endTime": "string"
}
}Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "postId": "string",
- "entityId": [
- "string"
], - "publishers": [
- "string"
], - "text": "string",
- "photoUrls": [
- "string"
], - "topicType": "string",
- "alertType": "string",
- "offer": {
- "couponCode": "string",
- "redeemOnlineUrl": "string",
- "termsConditions": "string"
}, - "clickthroughUrl": "string",
- "callToActionType": "string",
- "eventInfo": {
- "title": "string",
- "startTime": "string",
- "endTime": "string"
}, - "createdDate": "string",
- "postDate": "string",
- "postCreatedInYext": true,
- "entityPosts": [
- {
- "entityPostId": "string",
- "entity": {
- "id": "string"
}, - "publisher": "INSTAGRAM",
- "status": {
- "status": "POST_SCHEDULED",
- "details": "string"
}, - "metrics": {
- "viewCount": 0,
- "uniqueViewCount": 0,
- "clickCount": 0,
- "likeCount": 0,
- "loveCount": 0,
- "wowCount": 0,
- "hahaCount": 0,
- "sadCount": 0,
- "angerCount": 0
}, - "comments": [
- {
- "commentId": "string",
- "parentCommentId": "string",
- "authorName": "string",
- "text": "string",
- "hidden": true,
- "likes": 0,
- "createdTimestamp": true,
- "replies": [
- {
- "commentId": "string",
- "parentCommentId": "string",
- "authorName": "string",
- "text": "string",
- "hidden": true,
- "likes": 0,
- "createdTimestamp": true
}
]
}
]
}
]
}
}Post: Delete
Delete a social post.
NOTE: Posts that have status POST_PROCESSING may not be deleted.
path Parameters
| accountId required | string |
| postId required | string The ID of a specific post. To delete individual entity posts, please use the Entity Post: Delete endpoint. |
query Parameters
| v required | string A date in |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": { }
}Entity Post: Delete
Delete a specific entity post
path Parameters
| accountId required | string |
| entityPostId required | string The ID of an individual post created for a given entity on a given publisher. |
query Parameters
| v required | string A date in |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": { }
}Comment: Create
Comment on a specific entity post.
path Parameters
| accountId required | string |
| entityPostId required | string The ID of an individual post created for a given entity on a given publisher. |
query Parameters
| v required | string A date in |
Request Body schema: application/json
| text | string The text of the comment. |
| parentCommentId | string If the comment is in response to another comment, this is the ID of the parent comment. Instagram and Facebook only |
Responses
Request samples
- Payload
{- "text": "string",
- "parentCommentId": "string"
}Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "commentId": "string",
- "text": "string",
- "parentCommentId": "string"
}
}Entity Post: Comments
Provided an entityPostId, returns a list of comments with pagination support.
path Parameters
| accountId required | string |
| entityPostId required | string The ID of an individual post created for a given entity on a given publisher. |
query Parameters
| v required | string A date in |
| pageToken | string If a response to a previous request contained the nextPageToken field, pass that field's value as the pageToken parameter to retrieve the next page of data. |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "comments": [
- {
- "commentId": "string",
- "parentCommentId": "string",
- "authorName": "string",
- "text": "string",
- "hidden": true,
- "likes": 0,
- "createdTimestamp": true,
- "replies": [
- {
- "commentId": "string",
- "parentCommentId": "string",
- "authorName": "string",
- "text": "string",
- "hidden": true,
- "likes": 0,
- "createdTimestamp": true
}
]
}
], - "nextPageToken": "string"
}
}Comment: Delete
Delete a comment on a specific entity post.
path Parameters
| accountId required | string |
| entityPostId required | string The ID of an individual post created for a given entity on a given publisher. |
| commentId required | string |
query Parameters
| v required | string A date in |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": { }
}