<% 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 Content Track Completed Pages Track Completed Page Builder 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 Knowledge Assistant Track Completed Multi-Language Experiences Track Completed Fall '22 Release Highlights Track Completed Spring '23 Release Highlights Track Completed Chat Track Completed Summer '23 Release Highlights Track Completed Fall '23 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
< DOCS HOME
Search
Management APIs
No results in this galaxy.
Try searching all of Hitchhikers here.
Introduction
Overview - Policies and Conventions
API Availability
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
Content
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: 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
Entity Post: Delete
Comment: Create
Entity Post: Comments
Comment: Delete
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

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

Suggestion: Comment

Add a comment to a suggestion.

NOTE:

  • App must have Manage Suggestions: Read/Write permission to utilize endpoint.
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.

Request Body schema: application/json

Comment to be added to the suggestion. Only the text field of the comment object can be specified.

text
string

Responses

Request samples

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

Response samples

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

Suggestion: Action

Perform an action on the Suggestion with the given ID.

This endpoint allows apps to lock, unlock, reassign, modify the status (approve or reject), and update the content of suggestions. The source of the update will be the Yext App ID of the app making the request.

NOTE:

  • App must have Manage Suggestions: Read/Write permission to utilize endpoint.
  • Only one of locked, assignee, status, or entityFieldSuggestion can be provided in the request.
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
Request Body schema: application/json

Actions to take on the suggestion

status
string

The status of the suggestion. Provide APPROVED to approve the suggestion or REJECTED to reject the suggestion.

locked
boolean

Boolean value specifying if the field the suggestion is on is locked or not. Only valid for suggestions where status = PENDING and destinationType = ENTITY.

object

Object containing information about who the suggestion is assigned to.

Omitted if suggestion is unassigned.

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
{
  • "status": "string",
  • "locked": true,
  • "assignee": {
    },
  • "entityFieldSuggestion": {
    }
}

Response samples

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