<% user.full_name %>
<% util.level ? util.level.title : '' %>
Explorer Pioneer Apollo Viking Voyager Pathfinder Orion
Points
<% user.points ? user.points.toLocaleString() : 0 %>
Badges
<% util.badgeCount %>
Streaks
Congratulations You've <% util.newestBadge.isCurriculum ? 'completed' : 'earned' %> the
<% util.newestBadge.title %> <% util.newestBadge.isCurriculum ? 'curriculum' : 'badge' %>!
previous
next
Share to Social Media
Linked In Facebook
Status
<% util.level ? util.level.title : '' %>
<% util.level ? util.level.points : '' %>
<% util.nextLevel ? util.nextLevel.title : '' %>
<% util.nextLevel ? util.nextLevel.points : '' %>
Level up! <% util.levelPointsRemaining %> points to go
Level up! <% util.levelPointsRemaining %> points to go
Badges
Completed Hitchhikers Track Completed Knowledge Graph Track Completed Pages Track Completed Search Backend Track Completed Search Frontend Theme Track Completed Search UI React Track Completed Solution Templates and the Admin Console Track Completed Technical Skills Track Completed Platform Basics Track Completed Listings Track Completed Reviews Track Completed Industry Overview Track Completed Analytics Track Completed Industry Overview & Product Basics Track Completed Multi-Language Experiences Track Completed Chat Track
<% util.expandBadges ? 'Less' : 'More' %>
Playground Accounts
New +
No Playground Accounts
Create Playground +
View Profile
Log Out loading
Mission Complete! 🚀
Congratulations, you’ve completed your first module!

We hope you enjoy exploring the rest of the site. Please don’t forget to leave us feedback - we are constantly looking to improve. Happy Hitchhiking!
Home
Welcome to Hitchhikers! 👋
To learn more about the platform we encourage you to get started by completing the Hitchhikers Program Track and earning your first badge!
Start Here
Close notification
< DOCS HOME
Search
Management APIs
No results in this galaxy.
Try searching all of Hitchhikers here.
Introduction
Overview - Policies and Conventions
API Availability
Quotas and Rate Limits
Authentication
Versioning
Serialization
Content-Type Headers
PUT Requests
Dates and Times
Account ID
Actor Headers
Response Format
Client vs Yext-assigned IDs
Logging
Errors
Issues and Warnings
Status Codes
Changelog
May 14, 2025 Release
April 2, 2025 Release
February 19, 2025 Release
December 11, 2024 Release
October 30, 2024 Release
September 18, 2024 Release
September 10, 2024 Release
August 7, 2024 Release
July 2, 2024 Release
May 15, 2024 Release
April 3, 2024 Release
Knowledge Graph
Entities
Entities: List
Entities: Create
Entities: Get
Entities: Update
Entities: Delete
Entity Language Profiles: List
Entity Language Profiles: List All
Entity Language Profiles: Get
Entity Language Profiles: Upsert
Entity Language Profiles: Delete
Suggestions
Suggestion: Upsert
Suggestions: List
Suggestion: Cancel
Suggestion: Get
Suggestion: Comment
Suggestion: Action
Connectors
Connectors: Push Data
Connectors: Trigger
Connectors: Get Run
Connectors: Approve Run
Connectors: Cancel Run
Folders
Folders: List
Assets
Assets: List
Assets: Create
Assets: Get
Assets: Update
Assets: Delete
Categories & Google Attributes
Categories: List
Google Fields: List
ECLs
Menus: List
Menus: Create
Menus: Get
Menus: Update
Menus: Delete
Bios: List
Bios: Create
Bios: Get
Bios: Update
Bios: Delete
Products: List
Products: Create
Products: Get
Products: Update
Products: Delete
Events (Legacy): List
Events (Legacy): Create
Events (Legacy): Get
Events (Legacy): Update
Events (Legacy): Delete
Computations
Computations: Create Operation
Computations: List Operations
Computations: Cancel Operation
Computations: Get Operation
Legacy
Locations (Legacy): List
Locations (Legacy): Create
Locations (Legacy): Search
Locations (Legacy): Get
Locations (Legacy): Update
Custom Fields: List
Custom Fields: Create
Custom Fields: Get
Custom Fields: Update
Custom Fields: Delete
Language Profiles (Legacy): List
Language Profiles (Legacy): Get
Language Profiles (Legacy): Upsert
Language Profiles (Legacy): Delete
Listings
Listings Management
Listings: List
Listings: Opt In
Listings: Opt Out
Entity Listings: List
Entity Listings: Delete
Duplicate Suppression
Duplicates: List
Duplicates: Create
Duplicates: Delete
Duplicates: Suppress
Publishers
Publishers: List
Publisher Suggestions
Publisher Suggestions: List
Publisher Suggestions: Get
Publisher Suggestions: Update
Google Verification
Verification Methods: List
Verification Statuses: List
Verification: Initiate
Verification: Complete
Google Admin
Listing Admins: List
Listing Admin: Invite
Q&A
Questions: List
Question: Get
Answer: Create
Answer: Update
Answer: Delete
Analytics
Catalog
Catalog
Max Dates
Max Dates
Reports
Reports
Report Status
Report Status
Reviews
Review Management
Reviews: List
Reviews: Create
Review: Get
Review: Update
Comment: Create
Comment: Generate
Comment: Update
Comment: Delete
Review Labels: Update
Review Generation
Review Invitations: List
Review Invitations: Create
Review Invitation: Get
Review Invitation: Update
Review Invitation: Delete
Review Generation Settings: Get
Review Generation Settings: Update
Logs
Tables
Tables
Table Schema
Table Schema
Query
Query
Social
Post
Posts: List
Post: Create
Post: Get
Post: Update
Post: Delete
Post: Generate Text
Entity Post: Delete
Comment: Create
Entity Post: Comments
Comment: Delete
Video: Upload
Eligibility: Get
Conversation: Get
Messages: List
Messages: Create
Account Settings
Users
Roles: Get
Users: List
Users: Create
Users: Get
Users: Update
Users: Delete
Users: Update Password
Approval Groups: List
Approval Groups: Create
Approval Groups: Get
Approval Groups: Update
Approval Groups: Delete
Accounts
Accounts: List
Accounts: Get
Linked Accounts
LinkedAccounts: List
LinkedAccounts: Get
LinkedAccounts: Assign
Optimization Tasks
Optimization Tasks: List
Optimization Tasks: Get Link
Configuration
Configuration
Resource Names: List
Resource Configuration: Get
Resource Configuration: Update
Resource Configuration: Patch
Resource Configuration: Create
Licenses
Licenses
License Assignment: Create
License Assignment: Delete
License Assignment: Update
License Packs: List
License Assignments: List
Webhooks
Content Endpoints
Content: Webhook
ECLs
Menus: Webhook
Bios: Webhook
Products: Webhook
Events: Webhook
Entities
Entities: Webhook
Suggestions
Suggestions: Webhook
Listings
Listings: Webhook
Entity Listings: Webhook
Duplicates: Webhook
Publisher Suggestions: Webhook
Q&A: Webhook
Reviews
Reviews: Webhook
Reviews Invitations: Webhook
Unlink Account
Account Unlink: Webhook
Agreements
Add Request Update: Webhook
Legacy
Locations: Webhook
Agreements (Reseller Admin)
Available Services
Available Services: List
Add Requests
Add Requests: Create (New Location)
Add Requests: Create (Existing Location)
Add Requests: Create (Existing Account)
Add Requests: Process (Sandbox API Only)
Add Requests: List (Location)
Add Requests: Get (Location)
Add Requests: List (Sub-Account)
Add Requests: Get (Sub-Account)
Services
Services: Cancel (Location)
Services: Cancel (Account)
Services: Cancel All (Account)
Services: List (Location)
Services: List (Sub-Account)
Accounts
Accounts: Create Sub-Account
Accounts: List
Accounts: Get
Accounts: Update
Resources Apply Requests
Resources Apply Request: Create (Account)
Resources Apply Request Status: Get (Account)
home
API docs by Redocly

Posts: List

Retrieve Social Posts 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: "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:

  • POST_SCHEDULED
  • POST_AWAITING_APPROVAL
  • POST_SUCCEEDED
  • POST_PROCESSING
  • DELETE_PROCESSING
  • POST_FAILED
  • DELETE_FAILED
  • 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: "INSTAGRAM" "FACEBOOK" "FIRSTPARTY" "GOOGLEMYBUSINESS" "LINKEDIN"

The publisher the post should be sent to.

text
string

The copy to be featured on the post.

Please note that you should use double brackets for embedded fields if your v parameter is on or after 20250514. If you are using the response from a Post: Generate Post Text call, then your v parameter must be on or after 20250514, since responses from that call use double brackets for embedded fields.

Character limits vary per publisher. Please refer to the following character limits:

  • Google Business Profile: 1500
  • Facebook: 5000
  • First Party: 5000
  • LinkedIn: 3000
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.

Array of objects

Video to be posted to the publisher. Facebook and Instagram are supported and only one video can be uploaded per post.

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" "OFFER" "STANDARD"

The topicType of the post. Only supported on Google posts. Defaults to STANDARD.

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.

object

Additional data for offer posts. Only supported on Google posts.

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

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

object

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

Responses

Request samples

Content type
application/json
{
  • "entityIds": [
    ],
  • "publisher": "INSTAGRAM",
  • "text": "string",
  • "clickthroughUrl": "string",
  • "photoUrls": [
    ],
  • "videos": [
    ],
  • "postDate": "string",
  • "topicType": "ALERT",
  • "alertType": "ALERT_TYPE_UNSPECIFIED",
  • "offer": {
    },
  • "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.

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.

object

Additional data for offer posts. Only supported on Google posts.

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

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "photoUrls": [
    ],
  • "alertType": "ALERT_TYPE_UNSPECIFIED",
  • "offer": {
    },
  • "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": { }
}

Post: Generate Text

Generates caption, by using API, based on a set of criteria. The generated caption should then be provided as a value against the text field in the Post: Create call.

Please note that this endpoint returns embedded fields using double brackets. You MUST use a v parameter of20250514 or greater in the Post: Create call in order for the embedded fields to resolve correctly.

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/json
One of
textPrompt
required
string

The text input to guide the post text generation.

entityIds
required
Array of strings

ID(s) of the entities to generate post text for

publishers
Array of any
Items Enum: "INSTAGRAM" "FACEBOOK" "FIRSTPARTY" "GOOGLEMYBUSINESS" "LINKEDIN" "HEROLD"

Publishers that the post text should generated for

tone
string

Desired tone for the post text (eg. professional, friendly, humorous)

postType
string

Type of post (eg. advertisement, educational, industry news)

audience
string

Target audience description

keywords
Array of strings

List of keywords to include in the post text

language
string

Desired language for the post text

Responses

Request samples

Content type
application/json
Example
{
  • "textPrompt": "string",
  • "entityIds": [
    ],
  • "publishers": [
    ],
  • "tone": "string",
  • "postType": "string",
  • "audience": "string",
  • "keywords": [
    ],
  • "language": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "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 YYYYMMDD format.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "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 YYYYMMDD format.

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

Content type
application/json
{
  • "text": "string",
  • "parentCommentId": "string"
}

Response samples

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

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

Responses

Response samples

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

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

Responses

Response samples

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

Video: Upload

Upload a video to be used in a post.

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/json
publisher
required
string
Enum: "INSTAGRAM" "FACEBOOK"

Upload a video to Yext's CDN to be used in a post. A video must be in Yext's CDN in order to be used in a Create Post request.

videoUrl
required
string

A non Yext-CDN URL of a video to be posted to the publisher.

videoPostType
required
string
Enum: "REEL" "VIDEO"

The type of video post to be uploaded. Instagram only supports the REEL video post type.

uploadType
required
string
Value: "URL"

The type of upload. Only URL is supported at this time.

Responses

Request samples

Content type
application/json
{
  • "publisher": "INSTAGRAM",
  • "videoUrl": "string",
  • "videoPostType": "REEL",
  • "uploadType": "URL"
}

Response samples

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

Eligibility: Get

Fetch publisher eligibility for a given set of entities. If a publisher is ELIGIBLE for an entity, that means it can be posted to. If a publisher is INELIGIBLE for an entity, that means that it cannot be posted to.

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

publishers
required
Array of strings
Items Enum: "APPLE" "INSTAGRAM" "FACEBOOK" "FIRSTPARTY" "GOOGLEMYBUSINESS"

The publisher(s) for which to check for eligibility

entityIds
required
Array of strings

ID(s) of the entities for which to check for eligibility

Responses

Response samples

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

Conversation: Get

Fetches a full conversation for a userId \ entityId \ publisher. The userId can be retrieved from the Messages: List response.

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.

entityId
required
string

ID of the entity to fetch a conversation for.

publisher
required
string
Enum: "INSTAGRAM" "FACEBOOK"

The publisher(s) for which to fetch the conversation for

userId
required
string

ID of the user to fetch the conversation for

Responses

Response samples

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

Messages: List

Fetches the latest message sent by a user on a publisher / entityId.

To fetch the whole conversation for a specific user / publisher / entityId, provide the user.id that's returned in the response against the Conversation: Get endpoint.

To send a message to a specific user / publisher / entityId, provide the user.id that's returned in the response against the Messages: Create endpoint.

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.

entityIds
Array of strings

Filters messages that match the specified entityId(s)

publishers
Array of strings
Items Enum: "INSTAGRAM" "FACEBOOK"

Filters messages that match specified publisher(s)

userName
string

Filters messages that match the user name (Facebook name or Instagram handle)

messageText
string

Filters messages that match the specified text

sortBy
Array of strings
Items Enum: "OLDEST_TO_NEWEST" "NEWEST_TO_OLDEST"

Defaults to NEWEST_TO_OLDEST

readUnreadStatus
Array of strings
Items Enum: "READ" "UNREAD"

Filters messages that match the specified readUnreadStatus

minCreatedDate
string <date>

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.

maxCreatedDate
string <date>

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.

Responses

Response samples

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

Messages: Create

Sends a message to a specified userId \ publisher \ entityId. The userId can be retrieved from the Messages: List response.

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.

Request Body schema: application/json
entityId
required
string

ID of the entity to create a message for.

publisher
required
string
Enum: "INSTAGRAM" "FACEBOOK"

The publisher the message should be sent to.

userId
required
string

The publisher user ID that the message should be sent to.

text
required
string

The copy to be sent as the message. Character limits vary per publisher. Please refer to the following character limits: Facebook: 2000 Instagram: 1000

Responses

Request samples

Content type
application/json
{
  • "entityId": "string",
  • "publisher": "INSTAGRAM",
  • "userId": "string",
  • "text": "string"
}

Response samples

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