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

Add Requests: Create (New Location)

Request that a new location be added and services added to it. The location is created only if the "status" field returned is "COMPLETE". In most cases, the "status" returned in the Add Request: Create response will be "SUBMITTED". For a list and explanation of each possible "status", please see the Add Requests: Get (Location) section.

To receive real-time updates on the status of your Add Request, we recommend that you configure the Add Request Update: Webhook in the Developer Console (see the Configure Webhooks guide for more information). Alternatively, use the Add Requests: Get (Location) call to determine the current Add Request "status".

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/json
newLocationId
required
string

Your ID for the location to be added.

newLocationAccountId
string

(Partner Portal mode) Supply your ID for the account that the new location should be created in. If this account is your main account or an existing sub-account, the location will be placed there. Otherwise, a new account will be created.

newLocationAccountName
string

(Partner Portal mode) If a new account is created, this field's value will set the account's name. If a new account is created, and a value for this field is not provided, the new account's name will default to the location's name.

newAccountParentAccountId
string

(Partner Portal mode, advanced use only) If you have a multi-layer account structure and want the new account created for this request to be under one of your sub-accounts, rather than directly under your main account, specify that sub-account's ID in this field.

required
object

If you set newLocationId, you must specify either newLocationData or newEntityData.

This field allows you to set the profile data for a location, using our legacy format. Profile content is specified in the same format as when creating a location with the Locations: Create endpoint.

If the Add Request is processed successfully, this data will be used to create a new location in your account.

newEntityType
string
Default: "location"

If you set newEntityData, this field specifies the type of entity to be created.

required
object

If you set newLocationId, you must specify either newLocationData or newEntityData.

This field allows you to set the profile data for an entity. Profile content is specified in the same format as when creating an entity with the Entities: Create endpoint. You can only create entities of a type specified by newEntityType.

If the Add Request is processed successfully, this data will be used to create a new entity in your account.

The dropdown will specify the profile content for newEntityData. Specify the entity type with newEntityType described above.

skus
required
Array of strings

List of SKUs that you would like to sign the location up for, from among those listed in the Available Services: List response with Location recipientType.

agreementId
integer

(Advanced field) The Agreement ID of the agreement that services will be added under. This value is set automatically by Yext when you create the Add request. (You can specify it yourself, but should not do so unless you have intentionally set up multiple active agreements with Yext, since it could cause your integration to break when you renew or upgrade your agreement.)

forceReview
boolean

(Sandbox API only) Forces this Add request into the REVIEW status if it otherwise would have completed successfully.

Responses

Request samples

Content type
application/json
Example
{
  • "newLocationId": "string",
  • "newLocationAccountId": "CST-43843",
  • "newLocationAccountName": "Bill's Auto Shop",
  • "newAccountParentAccountId": "PAR-001",
  • "newLocationData": {
    },
  • "newEntityType": "atm",
  • "newEntityData": {
    },
  • "skus": [
    ],
  • "agreementId": 1588,
  • "forceReview": false
}

Response samples

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

Add Requests: Create (Existing Location)

Request that one or more available services be added to an existing location.

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/json
existingLocationId
required
string

ID of the location to add service for. It must already be in your account (or, if you use the Partner Portal, any of your sub-accounts).

existingLocationAccountId
string

(Partner Portal mode only) If the existingLocationId you specified is not unique among your sub-accounts, use this to specify which account the existing location is in.

skus
required
Array of strings

List of SKUs that you would like to sign the location up for, from among those listed in the Available Services: List response with Location recipientType.

agreementId
integer

(Advanced field) The Agreement ID of the agreement that services will be added under. This is set automatically by Yext when you create the add request. (You can specify it yourself, but should not do so unless you have intentionally set up multiple active agreements with Yext, since this could cause your integration to break when you renew or upgrade your agreement.)

forceReview
boolean

(Sandbox API only) Forces this add request into the REVIEW status if it otherwise would have completed successfully.

Responses

Request samples

Content type
application/json
{
  • "existingLocationId": "A48934",
  • "existingLocationAccountId": "B098329",
  • "skus": [
    ],
  • "agreementId": 1588,
  • "forceReview": false
}

Response samples

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

Add Requests: Create (Existing Account)

Request that one or more available services be added (or increased in quantity) to an existing account.

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/json
subAccountId
required
string

The existing account ID to add service to.

required
Array of objects

List of objects representing the SKUs to be added (or increased in quantity) to the account, from among those listed in the Available Services: List response with Sub-Account recipientType. If the sub-account already has an active service for a SKU, the service quantity will be increased. The added quantity will default to 1 for any SKU without a specified quantity.

agreementId
integer

(Advanced field) The Agreement ID of the agreement that services will be added under. This is set automatically by Yext when you create the add request. (You can specify it yourself, but should not do so unless you have intentionally set up multiple active agreements with Yext, since this could cause your integration to break when you renew or upgrade your agreement.).

Responses

Request samples

Content type
application/json
{
  • "subAccountId": "B093879",
  • "skuAdditions": [
    ],
  • "agreementId": 1588
}

Response samples

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

Add Requests: Process (Sandbox API Only)

Request that an add request in REVIEW be processed to COMPLETE, CANCELED, or FAILED. Only applicable for location add requests.

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/json
addRequestId
required
integer

ID of the add request with REVIEW status

status
required
string

Action to take on the add request.

Responses

Request samples

Content type
application/json
{
  • "addRequestId": 0,
  • "status": "COMPLETE"
}

Response samples

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

Add Requests: List (Location)

Get all of the add requests in the account that were created for locations. The response includes both New Location Add Requests and Existing Location Add Requests.

Possible status values for each add request:

  • SUBMITTED - The request has been submitted for processing. Updated status should be available soon, usually within seconds.
  • PROCESSING - The request is currently being processed. Updated status should be available soon, usually within seconds.
  • COMPLETE - The request was successfully processed and service was added. You can verify this by retrieving services for the location.
  • CANCELED - The request was purposefully canceled by Yext and was not processed. Details are available in the results field.
  • REVIEW - The request is being reviewed by Yext, most likely because this location may be a duplicate of another location already receiving this service through Yext. Once the review is complete, status will be updated to either CANCELED or COMPLETE.
  • FAILED - Processing the request failed due to a technical issue. Details may be available in the statusDetail field. No changes were made to your account, so you can try the request again.
path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

status
string
Enum: "SUBMITTED" "PROCESSING" "COMPLETE" "CANCELED" "REVIEW" "FAILED"

Filters the list to add requests in a specific status.

submittedAfter
string <date>

(YYYY-MM-DDThh:mm:ss format)

submittedBefore
string <date>

(YYYY-MM-DDThh:mm:ss format)

updatedAfter
string <date>

(YYYY-MM-DDThh:mm:ss format)

updatedBefore
string <date>

(YYYY-MM-DDThh:mm:ss format)

sku
string
agreementId
integer
locationId
string
limit
integer <= 1000
Default: 100
offset
integer
Default: 0

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

Responses

Response samples

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

Add Requests: Get (Location)

Get status information about an add request that was previously created for a location.

Possible statuses:

  • SUBMITTED - The request has been submitted for processing. Updated status should be available soon, usually within seconds.
  • PROCESSING - The request is currently being processed. Updated status should be available soon, usually within seconds.
  • COMPLETE - The request was successfully processed and service was added. You can verify this by retrieving services for the location.
  • CANCELED - The request was purposefully canceled by Yext and was not processed. Details are available in the results field.
  • REVIEW - The request is being reviewed by Yext, most likely because this location may be a duplicate of another location already receiving this service through Yext. Once the review is complete, status will be updated to either CANCELED or COMPLETE.
  • FAILED - Processing the request failed due to a technical issue. Details may be available in the statusDetail field. No changes were made to your account, so you can try the request again.
path Parameters
accountId
required
string
addRequestId
required
integer

addRequestId returned from a previous call to Add Requests: Create (New Location), Add Requests: Create (Existing Location), or retrieved from Add Requests: List (Location)

query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

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

Add Requests: List (Sub-Account)

Get all of the add requests in the account that were created for sub-accounts.

Possible status values for each add request:

  • SUBMITTED - The request has been submitted for processing. Updated status should be available soon, usually within seconds.
  • PROCESSING - The request is currently being processed. Updated status should be available soon, usually within seconds.
  • COMPLETE - The request was successfully processed and service was added. You can verify this by retrieving services for the sub-account.
  • CANCELED - The request was purposefully canceled by Yext and was not processed. Details are available in the results field.
  • FAILED - Processing the request failed due to a technical issue. Details may be available in the statusDetail field. No changes were made to your account, so you can try the request again.
path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

status
string
Enum: "SUBMITTED" "PROCESSING" "COMPLETE" "CANCELED" "FAILED"

Filters the list to add requests in a specific status.

submittedAfter
string <date>

(YYYY-MM-DDThh:mm:ss format)

submittedBefore
string <date>

(YYYY-MM-DDThh:mm:ss format)

updatedAfter
string <date>

(YYYY-MM-DDThh:mm:ss format)

updatedBefore
string <date>

(YYYY-MM-DDThh:mm:ss format)

sku
string
agreementId
integer
subAccountId
string
limit
integer <= 1000
Default: 100
offset
integer
Default: 0

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

Responses

Response samples

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

Add Requests: Get (Sub-Account)

Get status information about an add request that was previously created for a sub-account.

Possible statuses:

  • SUBMITTED - The request has been submitted for processing. Updated status should be available soon, usually within seconds.
  • PROCESSING - The request is currently being processed. Updated status should be available soon, usually within seconds.
  • COMPLETE - The request was successfully processed and service was added. You can verify this by retrieving services for the sub-account.
  • CANCELED - The request was purposefully canceled by Yext and was not processed. Details are available in the results field.
  • FAILED - Processing the request failed due to a technical issue. Details may be available in the statusDetail field. No changes were made to your account, so you can try the request again.
path Parameters
accountId
required
string
addRequestId
required
integer

addRequestId returned from a previous call to Add Requests: Create (Existing Account) or retrieved from Add Requests: List (Sub-Account)

query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

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