<% 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 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 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
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
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
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)
home
API docs by Redocly

Review Invitations: List

Retrieves all review invitations for an account

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

limit
integer <= 100
Default: 10

Number of results to return

offset
integer <= 9900
Default: 0

Number of results to skip. Used to page through results. Cannot be used together with pageToken.

If the v parameter is before 20240626, the maximum offset is not enforced. However, users are still encouraged to migrate to pageToken for queries requiring large offsets, as these may result in errors.

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.

The pageToken parameter will only be respected with the inclusion of a v parameter of 20240626 or later.

locationIds
Array of strings

When provided, only invitations for the requested locations will be returned.

Example: loc123,loc456,loc789

folderIds
Array of strings

When provided, only invitations for locations in the given folders and their subfolders will be included in the results.

locationLabels
Array of strings

When present, only invitations for locations with the provided labels will be returned.

templateIds
Array of strings

When provided, only invitations using the provided templateIds will be returned.

status
string
Enum: "ACCEPTED" "REJECTED" "PENDING"

When provided, only invitations of the chosen status will be returned.

type
string
Enum: "EMAIL" "SMS"

When provided, only invitations of the selected type will be returned.

Responses

Response samples

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

Review Invitations: Create

Sends review invitations to one or more consumers.

Optional fields

  • templateId
  • transactionId

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/json
Array
required
object
firstName
required
string

The first name of the person from whom a review is being requested.

lastName
required
string

The last name of the person from whom a review is being requested.

contact
required
string

The email address or phone number of the person from whom a review is being requested.

Phone numbers should be formatted in one of the following ways:

  • E.164 standard international format, with a leading "+"
  • National format, according to the country of the corresponding location
title
string

The title of the person from whom a review is being requested (e.g., Mr., Mrs., Miss, etc.).

includeImage
boolean

Only valid for SMS invitations.

If set to true, include the image provided in the relevant template in the SMS invitation. Please note that an image counts as an SMS message towards your SMS capacity.

Otherwise, the SMS message will not include an image.

If the v parameter is before 20210728, please refer to image as the parameter name instead of includeImage.

templateId
string

If specified, the ID of the template used to format the email.

If not specified, the entity’s default email template is used. If the entity has no default template, the account’s default template is used.

transactionId
string

The ID of the transaction being reviewed in response to this invitation.

language
string

The ISO 639-1 code of the review invitation's language. Only valid for invitations created from built-in templates. Defaults to en.

Supported languages:

  • en
  • de
  • fr
  • es
  • it
  • nl
  • ja
additionalURLParameters
string

A JSON object containing the key, value pairs for any additional URL parameters. These URL parameters will be appended to the First-Party Review Collection URL.

The additionalURLParameters parameter will only be respected with the inclusion of a v parameter of 20210728 or later.

sendInvitationFromYext
boolean

Defaults to true. If set to false, Yext will not fulfill the invitation and will simply return the created invitation object.

The sendInvitationFromYext parameter will only be respected with the inclusion of a v parameter of 20210728 or later.

reviewLabelNames
Array of strings

The names of the Review Labels which will be attached to the resulting review.

This is an upsert operation, meaning the system will determine if a Review Label exists already in your account, and create and append a new label if not.

The reviewLabelNames parameter will only be respected with the inclusion of a v parameter of 20210728 or later.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

Review Invitation: Get

Retrieve a specific review invitation.

path Parameters
accountId
required
string
invitationUid
required
string

The UID of this Review Invitation. This UID can be included as part of Review Creation requests for attribution.

query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

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

Review Invitation: Update

Supports updating an existing review invitation. This endpoint will not create a new review invitation or trigger a new SMS/Email to be sent, it will only update the data and/or metadata for an existing review invitation. Any optional parameters which are excluded from the request will simply be ignored.

path Parameters
accountId
required
string
invitationUid
required
string

The UID of this Review Invitation. This UID can be included as part of Review Creation requests for attribution.

query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/json
sent
integer <int64>

The timestamp the invitation was sent (seconds since epoch), if the invitation was sent.

opened
integer <int64>

The timestamp the invitation was opened (seconds since epoch), if the invitation was opened. This value will always be null for SMS type invitations.

clicked
integer <int64>

The timestamp the invitation was clicked (seconds since epoch).

reviewed
integer <int64>

The timestamp the review was generated as a result of this invitation (seconds since epoch).

If the v parameter is before 20210728, please refer to responded as the parameter name instead of reviewed.

firstName
string

The first name of the person from whom a review is being requested.

The firstName parameter will only be respected for v parameters of 20210728 or later.

lastName
string

The last name of the person from whom a review is being requested

The lastName parameter will only be respected for v parameters of 20210728 or later.

title
string

The title of the person from whom a review is being requested (e.g., Mr., Mrs., Miss, etc.)

The title parameter will only be respected for v parameters of 20210728 or later.

contact
string

The email address or phone number of the person from whom a review is being requested.

Phone numbers should be formatted in one of the following ways:

  • E.164 standard international format, with a leading "+"
  • National format, according to the country of the corresponding location

The contact parameter will only be respected for v parameters of 20210728 or later.

transactionId
string

The ID of the transaction being reviewed in response to this invitation.

The transactionId parameter will only be respected for v parameters of 20210728 or later.

additionalURLParameters
string

A JSON object containing the key, value pairs for any additional URL parameters. These URL parameters will be appended to the First-Party Review Collection URL.

The additionalURLParameters parameter will only be respected for v parameters of 20210728 or later.

status
string
Value: "CANCELED"

Cancel an existing review invitation with PENDING status by updating status to CANCELED Please note that if the invitation status is not PENDING, attempting to set the status to CANCELED will fail.

errorCode
string

The error code of the invitation if applicable. Required if errorReason is specified.

The errorCode parameter will only be respected for v parameters of 20210727 or earlier.

errorReason
string

The error reason text of the invitation if applicable. Required if errorCode is specified.

The errorReason parameter will only be respected for v parameters of 20210727 or earlier.

Responses

Request samples

Content type
application/json
{
  • "sent": 0,
  • "opened": 0,
  • "clicked": 0,
  • "reviewed": 0,
  • "firstName": "string",
  • "lastName": "string",
  • "title": "string",
  • "contact": "string",
  • "transactionId": "string",
  • "additionalURLParameters": "string",
  • "status": "CANCELED",
  • "errorCode": "string",
  • "errorReason": "string"
}

Response samples

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

Review Invitation: Delete

Delete a specific review invitation.

path Parameters
accountId
required
string
invitationUid
required
string

The UID of this Review Invitation. This UID can be included as part of Review Creation requests for attribution.

query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

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

Review Generation Settings: Get

Returns all current generation settings for a specified account.

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

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

Review Generation Settings: Update

Updates any generation settings specified in a specified account. Call may include any/all settings available to the account. Settings not included will remain unchanged.

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/json
maxEmailsPerDay
integer [ 0 .. 200 ]

Enables review invitations by email and indicates the maximum number of email invites our system will send on a per-location, per-day basis.

Must contain an integer value between 0 and 200. If 0 or null, review invitations by email will be disabled.

maxTextsPerMonth
integer >= 1

Indicates the maximum number of text invites our system will send on a per-location, per-month basis.

maxTextsPerDay
integer [ 1 .. 20 ]

Enables review invitations by text and indicates the maximum number of text invites our system will send on a per-location, per-day basis. We will send a maximum of 20 text invites per location per day.

If null, review invitations by text will be disabled.

maxContactsAllTime
integer
Value: 1

When enabled, this setting will prevent you from contacting the same person more than once. This setting cannot be set when maxContactFrequency is enabled.

If null, this setting will be disabled.

maxContactFrequency
integer
Enum: 7 30 60 90

Indicates the minimum number of days that must pass before a given contact can be sent another review invitation. This setting will prevent you from contacting the same person repeatedly in a short time period.

If null, no maximum contact frequency will be enforced.

reviewQuarantineDays
integer [ 0 .. 7 ]

Prevents first-party reviews from immediately showing up on your website or wherever else you show your reviews. During this quarantine period, you may respond to reviews, increasing the likelihood that your customers will revise or remove their negative reviews.

privacyPolicy
string

Review-collection pages contain a link to the Yext privacy policy by default. This field lets you replace that link with a link to your own privacy policy.

Update request must contain a URL or null. If null, the Yext privacy policy link will be used.

If the v parameter is before 20200910, please refer to privacyPolicyOverride as the parameter name instead of privacyPolicy.

balancingOptimization
string
Enum: "DISTRIBUTION" "MORE_REVIEWS" "MUST_BE_LOGGED_IN"

Defaults to DISTRIBUTION. Optionally configure the algorithm to prioritize sites where you have fewer reviews to generate more reviews (MORE_REVIEWS), or prioritize sites where a user is already logged in on their device (MUST_BE_LOGGED_IN).

algorithmConfiguration
Array of strings[ items <= 3 items unique ]
Items Enum: "WEBSITE" "RECENCY" "RATING"

Optionally prioritize the following issues to determine where to send review invites: WEBSITE: generate more first-party reviews if one of the last 5 reviews has 1 star, RATING: prioritize sites that have the lower rating, RECENCY: prioritize sites that haven’t received a review in the last month.

object >= 0 properties

Configure the target distribution of reviews for each site by specifying the ratio as an integer for each site to generate reviews for. E.g. GOOGLEMYBUSINESS: 1 and FIRSTPARTY: 1, would send half of the review invites to Google and half to your First Party site.

Responses

Request samples

Content type
application/json
{
  • "maxEmailsPerDay": 200,
  • "maxTextsPerMonth": 1,
  • "maxTextsPerDay": 1,
  • "maxContactsAllTime": 1,
  • "maxContactFrequency": 7,
  • "reviewQuarantineDays": 7,
  • "privacyPolicy": "string",
  • "balancingOptimization": "DISTRIBUTION",
  • "algorithmConfiguration": [
    ],
  • "siteDistribution": {
    }
}

Response samples

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