loading

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 YYYYMMDD format.

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: "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:

  • POST_SCHEDULED
  • POST_AWAITING_APPROVAL
  • POST_SUCCEEDED
  • POST_DELETED
  • POST_PROCESSING
  • DELETE_PROCESSING
  • POST_FAILED
  • DELETE_FAILED
  • AWAITING_APPROVAL
  • REJECTED_BY_APPROVER

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Post: Create

Create a new social post.

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/json
entityIds
required
Array of strings

ID(s) of the entities to post for

publisher
required
string
Enum: "FACEBOOK" "FIRSTPARTY" "GOOGLEMYBUSINESS"

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:

  • Google Business Profile: 1500
  • Facebook: 5000
  • First Party: 5000
clickthroughUrl
string

Url included with the post.

photoUrls
Array of strings

List of publicly accessible URLs where the photos can be retrieved from.

NOTE: Currently only supports one photo.

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 YYYY-MM-DD HH:MM:SS. Ex: 2021-04-06 08:45:00. The timezone for the provided datetime will be UTC.

topicType
string
Enum: "ALERT" "EVENT" "STANDARD"

The topicType of the post. Only supported on Google posts.

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 ALERT, and behaves as a sub-type of Alerts. Only supported on Google posts.

callToActionType
string
Enum: "BOOK" "CALL" "LEARN_MORE" "ORDER" "SHOP" "SIGN_UP"

The actionType of the post. Required for Google posts that include a clickthroughUrl. Only supported on Google posts.

object

Event information. Required for topicType EVENT. Only supported on Google posts.

Responses

Request samples

Content type
application/json
{
  • "entityIds": [
    ],
  • "publisher": "FACEBOOK",
  • "requiresApproval": true,
  • "text": "string",
  • "clickthroughUrl": "string",
  • "photoUrls": [
    ],
  • "postDate": "string",
  • "topicType": "ALERT",
  • "alertType": "ALERT_TYPE_UNSPECIFIED",
  • "callToActionType": "BOOK",
  • "eventInfo": {
    }
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

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 YYYYMMDD format.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

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 YYYYMMDD format.

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.

topicType
string
Enum: "ALERT" "EVENT" "STANDARD"

The topicType of the post. Only supported on Google posts.

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 ALERT, and behaves as a sub-type of Alerts. Defaults to ALERT_TYPE_UNSPECIFIED.

callToActionType
string
Enum: "BOOK" "CALL" "LEARN_MORE" "ORDER" "SHOP" "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 EVENT. Only supported on Google posts.

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "photoUrls": [
    ],
  • "topicType": "ALERT",
  • "alertType": "ALERT_TYPE_UNSPECIFIED",
  • "callToActionType": "BOOK",
  • "clickthroughUrl": "string",
  • "eventInfo": {
    }
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

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 YYYYMMDD format.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": { }
}