<% 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 Program Track Completed Knowledge Graph Track Completed Pages Track Completed Page Builder Track Completed Search Track Completed Search: Advanced 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 Knowledge Assistant Track Completed Multi-Language Experiences Track Completed Fall '22 Release Highlights 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
Search
API Policies & Conventions
Knowledge APIs
Expand Expand
Knowledge Graph
Expand Expand
Entities
Expand Expand
Entities
Expand Expand
Entities: List
Entities: Create
Entities: Get
Entities: Update
Entities: Delete
Entity Language Profiles
Expand Expand
Entity Language Profiles: List
Entity Language Profiles: List All
Entity Language Profiles: Get
Entity Language Profiles: Upsert
Entity Language Profiles: Delete
Locations (Legacy)
Expand Expand
Locations (Legacy): List
Locations (Legacy): Create
Locations (Legacy): Search
Locations (Legacy): Get
Locations (Legacy): Update
Language Profiles (Legacy)
Expand Expand
Language Profiles (Legacy): List
Language Profiles (Legacy): Get
Language Profiles (Legacy): Upsert
Language Profiles (Legacy): Delete
Folders
Expand Expand
Folders: List
ECLs
Expand Expand
Menus
Expand Expand
Menus: List
Menus: Create
Menus: Get
Menus: Update
Menus: Delete
Bios
Expand Expand
Bios: List
Bios: Create
Bios: Get
Bios: Update
Bios: Delete
Products
Expand Expand
Products: List
Products: Create
Products: Get
Products: Update
Products: Delete
Events (Legacy)
Expand Expand
Events (Legacy): List
Events (Legacy): Create
Events (Legacy): Get
Events (Legacy): Update
Events (Legacy): Delete
Categories & Google Attributes
Expand Expand
Categories
Google Fields
Custom Fields
Expand Expand
Custom Fields: List
Custom Fields: Create
Custom Fields: Get
Custom Fields: Update
Custom Fields: Delete
Assets
Expand Expand
Assets: List
Assets: Create
Assets: Get
Assets: Update
Assets: Delete
Connectors
Expand Expand
Connectors: Push Data
Connectors: Trigger
Suggestions
Expand Expand
Suggestion: Upsert
Suggestions: List
Suggestion: Cancel
Suggestion: Get
Suggestion: Comment
Suggestion: Action
Listings
Expand Expand
Listings Management
Expand Expand
Listings
Expand Expand
Listings: List
Listings: Opt In
Listings: Opt Out
Entity Listings
Expand Expand
Entity Listings: List
Entity Listings: Delete
Duplicates
Expand Expand
Duplicates: List
Duplicates: Create
Duplicates: Delete
Duplicates: Suppress
Publishers
Publisher Suggestions
Expand Expand
Publisher Suggestions: List
Publisher Suggestions: Get
Publisher Suggestions: Update
Google Verification
Expand Expand
Verification Methods
Verification Statuses
Verification
Expand Expand
Verification: Initiate
Verification: Complete
Listing Admins
Expand Expand
Listing Admins: List
Listing Admin: Invite
Q&A
Expand Expand
Questions
Expand Expand
Questions: List
Question: Get
Answer
Expand Expand
Answer: Create
Answer: Update
Answer: Delete
Analytics
Expand Expand
Activity Log
Catalog
Max Dates
Reports
Report Status
Reviews
Expand Expand
Review Management
Expand Expand
Reviews
Expand Expand
Reviews: List
Reviews: Create
Review: Get
Review: Update
Comment
Expand Expand
Comment: Create
Comment: Update
Comment: Delete
Review Labels
Review Generation
Expand Expand
Review Invitations
Expand Expand
Review Invitations: List
Review Invitations: Create
Review Invitation: Get
Review Invitation: Update
Review Invitation: Delete
Review Generation Settings
Expand Expand
Review Generation Settings: Get
Review Generation Settings: Update
Logs
Expand Expand
Tables
Table Schema
Query
Social
Expand Expand
Post
Expand Expand
Post
Expand Expand
Posts: List
Post: Create
Post: Get
Post: Update
Post: Delete
Entity Post
Comment
Expand Expand
Comment: Create
Entity Post: Comments
Comment: Delete
Account Settings
Expand Expand
Users
Expand Expand
Roles
Users
Expand Expand
Users: List
Users: Create
Users: Get
Users: Update
Users: Delete
Users: Update Password
Approval Groups
Expand Expand
Approval Groups: List
Approval Groups: Create
Approval Groups: Get
Approval Groups: Update
Approval Groups: Delete
Accounts
Expand Expand
Accounts: List
Accounts: Get
Linked Accounts
Expand Expand
LinkedAccounts: List
LinkedAccounts: Get
LinkedAccounts: Assign
Optimization Tasks
Expand Expand
Optimization Tasks: List
Optimization Tasks: Get Link
Configuration
Expand Expand
Resource Names: List
Resource Configuration: Get
Resource Configuration: Update
Resource Configuration: Patch
Resource Configuration: Create
Webhooks
Expand Expand
Knowledge Graph
Expand Expand
Entities
Locations
ECLs
Expand Expand
Menus: Webhook
Bios: Webhook
Products: Webhook
Events: Webhook
Suggestions
Listings
Expand Expand
Listings
Entity Listings
Duplicates
Publisher Suggestions
Q&A
Reviews
Expand Expand
Reviews
Review Invitations
Content
Unlink Account
Expand Expand
Account Unlink: Webhook
Add Request
Expand Expand
Add Request Update: Webhook
Live APIs (Consumer Grade)
Expand Expand
Knowledge Graph Live API
Expand Expand
Entities
Expand Expand
Entities
Expand Expand
Entities: List
Entities: Get
Entities: GeoSearch
Entities Schema: Get
Entity Language Profiles
Expand Expand
Entity Language Profiles: Get
Entity Language Profiles: List
Entity Language Profiles: List All
Locations (Legacy)
Expand Expand
Language Profiles (Legacy): Get
Language Profiles Schema (Legacy): Get
Locations (Legacy): Get
Locations (Legacy): List
Locations Schema (Legacy): Get
Locations (Legacy): GeoSearch
ECLs
Expand Expand
Menus
Bios
Products
Events (Legacy)
Q&A Submission
Expand Expand
Q&A Submission
Review Submission
Expand Expand
Review Submission
Expand Expand
Review: Create
Review: Update
Review: Delete
Content
Expand Expand
Content
Expand Expand
Content: Get
Content: List
Search API
Expand Expand
Universal Search
Expand Expand
Universal Search: Autocomplete
Universal Search: Query
Vertical Search
Expand Expand
Vertical Search: Autocomplete
Vertical Search: Query
Vertical Search: Filter Search
Secure Token
Expand Expand
Secure Token
Admin APIs (Partner)
Expand Expand
Available Services
Expand Expand
Available Services: List
Add Requests
Expand Expand
Add Requests: Create (New Location)
Add Requests: Create (Existing Location)
Add Requests: Create (Existing Sub-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
Expand Expand
Services: Cancel (Location)
Services: Cancel (Sub-Account)
Services: Cancel All (Sub-Account)
Services: List (Location)
Services: List (Sub-Account)
Accounts
Expand Expand
Accounts: Create Sub-Account
Accounts: List
Accounts: Get
Accounts: Update
Resources Apply Requests
Expand Expand
Resources Apply Request: Create (Account)
Resources Apply Request Status: Get (Account)
Yext CLI (Beta)
Expand Expand
Installation
Getting Started
Expand Expand
Link Your Account
Exploring Commands & Using the Help Flag
Universal Commands
Expand Expand
init
info
completion
Resources Command Group
Expand Expand
apply
diff
pull
copy
Service Users Command Group
Expand Expand
activate
create
list
remove
Configuration Resources
Expand Expand
Analytics
Expand Expand
Conversion Action
Dashboard
Insight
Answers
Expand Expand
Answers Configuration
Experience Training
Saved Query
Crawler
Expand Expand
Yext Crawler
Knowledge Manager
Expand Expand
Connector
Entity
Entity Folder
Entity Label
Entity Preview
Entity Template
Entity Type
Entity Type Extension
Entity Upload Configuration
Field
Field Eligibility Group
Field Presentation
Field Type
Knowledge Graph Settings
Saved Filter
Listings
Expand Expand
Publisher
Pages
Expand Expand
Authentication Policy
Domain
Module
Page Builder Template
Site
Platform
Expand Expand
Account Features
Home Screen
Plugin
Role
Streams
Expand Expand
Streams Endpoint
home
API docs by Redocly

Suggestion: Upsert

Create or update a suggestion via API.

NOTE:

  • App must have Create Suggestions: Read/Write permission to utilize endpoint.
  • If a suggestion already exists from your app on the specified field, the suggestion will be updated.
  • Suggestions on ECLs are not currently supported.
path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

format
string >= 0 characters
Default: "markdown"

The formatting language used to parse rich text field values. Present if and only if the field is of type “Rich Text."

Valid values:

  • markdown
  • html
  • none
Request Body schema: application/json

The suggestion to be upserted

required
object

An object containing information about a suggestion for a single field on a single entity. Only valid if the suggestion is for a field on a single entity.

Responses

Request samples

Content type
application/json
{
  • "entityFieldSuggestion": {
    }
}

Response samples

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

Suggestions: List

Retrieve a list of Suggestions within an account

NOTE:

  • App must have either Create Suggestions: Read permission or Manage Suggestions: Read permission to utilize endpoint.
  • If App only has Create Suggestions: Read permission, only Suggestions created by the App in question will be returned.
  • Suggestions on ECLs are not supported.
  • Suggestions to the Categories field are only returned if they are for the Base Category List for your account. This means Suggestions on Category Overrides are not supported in the API today. Unless the Base Category List for your account is specifically set to a different list, the base list used is Yext's; in this default scenario, Publisher Suggestions to Categories will not be available via API, since these suggestions are made on the specific Publisher's Category List.
path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

format
string >= 0 characters
Default: "markdown"

The formatting language used to parse rich text field values. Present if and only if the field is of type “Rich Text."

Valid values:

  • markdown
  • html
  • none
entityIds
string >= 0 characters

Comma-separated list of entity IDs to pull suggestions for. Defaults to all entities in the account if unspecified.

entityUids
string >= 0 characters

Comma-separated list of entity UIDs (formerly known as Yext IDs) to pull suggestions for. Defaults to all entities in the account if unspecified.

statuses
string >= 0 characters

Comma-separated list of statuses of suggestions to pull. Defaults to all, but can be any of APPROVED, REJECTED, PENDING, CANCELED.

limit
number multiple of 1 <= 50
Default: "10"

Number of results to return. Default to 10, can go up to 50.

pageToken
string >= 0 characters

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.

sortBy
string >= 0 characters

Field and sort direction to order results by. The ordering should be a list with one element in the format of {"field_name": "sort_direction"}, where sort_direction is either "ascending" or "descending".

This param value needs to be URL encoded.

The following fields are supported for sorting:

  • uid
  • lastUpdatedDate

Responses

Response samples

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

Suggestion: Cancel

Cancel a suggestion which was submitted by the App.

NOTE:

  • App must have Create Suggestions: Read/Write permission to utilize endpoint.
  • Suggestions can only be canceled by the submitter.
path Parameters
accountId
required
string
suggestionUid
required
string

The Yext-generated unique identifier for the Suggestion.

query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

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

Suggestion: Get

Retrieve information for a Suggestion with a given ID

NOTE:

  • App must have either Create Suggestions: Read permission or Manage Suggestions: Read permission to utilize endpoint.
  • If App only has Create Suggestions: Read permission, only Suggestions created by the App in question will be returned.
  • Suggestions on ECLs are not supported.
  • Suggestions to the Categories field are only returned if they are for the Base Category List for your account. This means Suggestions on Category Overrides are not supported in the API today. Unless the Base Category List for your account is specifically set to a different list, the base list used is Yext's; in this default scenario, Publisher Suggestions to Categories will not be available via API, since these suggestions are made on the specific Publisher's Category List.
path Parameters
accountId
required
string
suggestionUid
required
string

The Yext-generated unique identifier for the Suggestion.

query Parameters
v
required
string

A date in YYYYMMDD format.

format
string >= 0 characters
Default: "markdown"

The formatting language used to parse rich text field values. Present if and only if the field is of type “Rich Text."

Valid values:

  • markdown
  • html
  • none

Responses

Response samples

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