Home
Products
Content
Import, store, and structure your data as entities.
Search
Build first-party search experiences on your website, app, and more.
Reviews
Monitor, respond, generate & analyze reviews.
Listings
Publish your data across Yext's Publisher Network.
Pages
Build SEO-ready landing pages.
Analytics
Analyze metrics and insights.
What's New
Check out our recent product releases.
Training
Docs
Community
Hitchhikers Community
Ask questions, share best practices, and engage with fellow Hitchhikers
Events
Explore the calendar of upcoming workshops and webinars
Blog
Gain insight into product functionality and best practices
Releases
Log in
Sign Up
<% user.full_name %>
<% util.level ? util.level.title : '-' %>
Sign up
Log in
If you don't have an account, sign up
here.
First Name
Last Name
Email
Password
BACK
Sign up
SKIP FOR NOW
You can always edit this later on your profile page
Log in
Send Email
Change Password
Reset Password
By clicking the Sign Up button, you are confirming you have read and agree to the
Hitchhikers Program and Site Terms
.
<% user.full_name %>
<% util.level ? util.level.title : '' %>
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' %>!
Share to Social Media
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
<% util.expandBadges ? 'Less' : 'More' %>
Playground Accounts
New +
No Playground Accounts
Create Playground +
<% account.name %>
Expires <% account.exp %> Day<% account.exp !== 1 ? 's' : '' %>
View Profile
Log Out
Sign up for Hitchhikers to get full access
If you're already a Hitchhiker, log in to access this content.
Log In
Sign Up
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
Error
<% error.body %>
Email us at
hitchhikers-support@yext.com
to get this issue resolved. Include a text copy of the above message to help expedite the process.
Email Support
Warning
<% warning.body %>
< DOCS HOME
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
Changelog
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
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: 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
Entity Post: Delete
Comment: Create
Entity Post: Comments
Comment: Delete
Video: Upload
Eligibility: List
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)
Webhooks
Feedback