<% 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 Knowledge Graph Track Completed Pages 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
Quotas and Rate Limits
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
June 25, 2025 Release
May 14, 2025 Release
April 2, 2025 Release
February 19, 2025 Release
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
Knowledge Graph
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
Post: Generate Text
Entity Post: Delete
Comment: Create
Entity Post: Comments
Comment: Delete
Video: Upload
Eligibility: Get
Conversation: Get
Messages: List
Messages: Create
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
Pages
Domains
Domain: Create
Domain: List
Domain: Get
Domain: Update
Domain: Delete
Migrate Legacy Pages Domain
Domain Association: Create
Domain Association: List
Domain Association: Get
Domain Association: Update
Domain Association: Delete
Managed CSR: Create
Managed CSR: List
Managed CSR: Get
Managed CSR: Delete
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

Domain: Create

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/json

Configuration for the domain to be created.

hostname
required
string

Fully qualified domain name that will be delegated to Yext.

wildcard
boolean
Default: false

If set to true, Domain Associations can be created for single-level subdomains of the given hostname.

destination
required
string
Value: "PAGES"

The Yext product the domain will be used for. Currently, only PAGES is supported.

integration_type
required
string
Enum: "USER_OWNED" "CUSTOM" "LEGACY_YEXT_MANAGED"

How the domain will be integrated with Yext. Only USER_OWNED is supported for domains created via the API.

object

SSL certificate will be automatically managed by Yext. Exactly one of managed_ssl, managed_csr, or custom_ssl_certificate must be set for a domain.

object

SSL certificate will be issued using the given Managed CSR. Exactly one of managed_ssl, managed_csr, or custom_ssl_certificate must be set for a domain.

object

The provided custom SSL certificate will be used for serving requests to the domain. Exactly one of managed_ssl, managed_csr, or custom_ssl_certificate must be set for a domain.

Responses

Request samples

Content type
application/json
{
  • "hostname": "www.example.com",
  • "wildcard": false,
  • "destination": "PAGES",
  • "integration_type": "USER_OWNED",
  • "managed_ssl": {
    },
  • "managed_csr": {
    },
  • "custom_ssl_certificate": {
    }
}

Response samples

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

Domain: List

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

hostname
Array of strings
Example: hostname=www.example.com,test.example.com

The hostname to filter results by. If not provided, results for all hostnames will be returned.

show_deleted
boolean
Default: false
page_size
integer [ 0 .. 50 ]
Default: 10

Number of results to return per page. Sizes above the maximum will be clamped at the maximum value.

page_token
string

Token to retrieve the next page of results. If not provided, the first page of results will be returned.

view
string
Default: "BASIC"
Enum: "FULL" "BASIC"

FULL returns all details, while BASIC omits certain SSL information. Using BASIC will also usually result in a lower response latency relative to using FULL.

Responses

Response samples

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

Domain: Get

path Parameters
accountId
required
string
domainId
required
string <uuid>
query Parameters
v
required
string

A date in YYYYMMDD format.

view
string
Default: "FULL"
Enum: "FULL" "BASIC"

FULL returns all details, while BASIC omits certain SSL information. Using BASIC will also usually result in a lower response latency relative to using FULL.

Responses

Response samples

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

Domain: Update

Update the configurations for the specified domain. Also triggers a check for Yext or SSL verification, if the Domain is not yet ACTIVE. See the update_mask parameter for fields that can be updated, any other provided fields will be ignored.

path Parameters
accountId
required
string
domainId
required
string <uuid>
query Parameters
v
required
string

A date in YYYYMMDD format.

force_move
boolean
Default: false

If true, and the domain is in a MOVE_REQUIRED state, will move ownership of the domain to this account.

update_mask
Array of strings
Default: "*"
Items Enum: "*" "managed_ssl.certificate_authority" "custom_ssl_certificate" "managed_csr.custom_public_certificate"

A comma-separated list of fields to update.

Request Body schema: application/json
object

SSL certificate will be automatically managed by Yext. Exactly one of managed_ssl, managed_csr, or custom_ssl_certificate must be set for a domain.

object

SSL certificate will be issued using the given Managed CSR. Exactly one of managed_ssl, managed_csr, or custom_ssl_certificate must be set for a domain.

object

The provided custom SSL certificate will be used for serving requests to the domain. Exactly one of managed_ssl, managed_csr, or custom_ssl_certificate must be set for a domain.

Responses

Request samples

Content type
application/json
{
  • "managed_ssl": {
    },
  • "managed_csr": {
    },
  • "custom_ssl_certificate": {
    }
}

Response samples

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

Domain: Delete

path Parameters
accountId
required
string
domainId
required
string <uuid>
query Parameters
v
required
string

A date in YYYYMMDD format.

force
boolean
Default: false

If true, Domain Associations using this domain will also be deleted. If not set or false, and if Domain Associations exist using this domain, an error will be returned.

Responses

Response samples

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

Migrate Legacy Pages Domain

Migrates a legacy Pages domain to a Domains API domain resource.

path Parameters
accountId
required
string
hostname
required
string

The hostname of the legacy domain to migrate.

query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

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

Domain Association: Create

Creating a Domain Association will begin serving the contents of the associated resource at the Domain Association's hostname (given DNS for the hostname is already set up).

path Parameters
accountId
required
string
domainId
required
string <uuid>
query Parameters
v
required
string

A date in YYYYMMDD format.

force_move
boolean
Default: false

If true, and the domain is in a MOVE_REQUIRED state, will move ownership of the domain to this account.

Request Body schema: application/json
hostname
string

For parent Domain's with wildcard=false, this will equal parent Domain's hostname. For parent Domain's with wildcard=true, this can be a single-level subdomain of the parent Domain's hostname.

object

The Pages site to associate with the parent Domain resource.

Responses

Request samples

Content type
application/json
{
  • "hostname": "www.example.com",
  • "site": {
    }
}

Response samples

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

Domain Association: List

path Parameters
accountId
required
string
domainId
required
string <uuid>

Set to "-" to reference Domain Associations from all domains in this account.

query Parameters
v
required
string

A date in YYYYMMDD format.

referenced_resources
Array of strings
Example: referenced_resources=accounts/123456/sites/6789,accounts/98765/sites/5678

Comma-separated list of associated resources to filter by.

page_size
integer [ 0 .. 50 ]
Default: 10

Number of results to return per page. Sizes above the maximum will be clamped at the maximum value.

page_token
string

Token to retrieve the next page of results. If not provided, the first page of results will be returned.

Responses

Response samples

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

Domain Association: Get

path Parameters
accountId
required
string
domainId
required
string <uuid>
domainAssociationId
required
string <uuid>
query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

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

Domain Association: Update

path Parameters
accountId
required
string
domainId
required
string <uuid>
domainAssociationId
required
string <uuid>
query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/json
object

The Pages site to associate with the parent Domain resource.

Responses

Request samples

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

Response samples

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

Domain Association: Delete

Deleting a Domain Association will stop serving the contents of the associated resource from the Domain Association's hostname.

path Parameters
accountId
required
string
domainId
required
string <uuid>
domainAssociationId
required
string <uuid>
query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

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

Managed CSR: Create

Creates a Certificate Signing Request (CSR) resource that can be used to provision SSL certificates. Once created, this resource can be referenced by Domains with the managed_csr SSL integration to provision certificates using this CSR and a public certificate.

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/json
required
object

Responses

Request samples

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

Response samples

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

Managed CSR: List

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

page_size
integer [ 0 .. 50 ]
Default: 10

Number of results to return per page. Sizes above the maximum will be clamped at the maximum value.

page_token
string

Token to retrieve the next page of results. If not provided, the first page of results will be returned.

view
string
Default: "BASIC"
Enum: "FULL" "BASIC"

FULL returns all details, while BASIC omits certain SSL information. Using BASIC will also usually result in a lower response latency relative to using FULL.

Responses

Response samples

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

Managed CSR: Get

path Parameters
accountId
required
string
managedCsrId
required
string <uuid>
query Parameters
v
required
string

A date in YYYYMMDD format.

view
string
Default: "FULL"
Enum: "FULL" "BASIC"

FULL returns all details, while BASIC omits certain SSL information. Using BASIC will also usually result in a lower response latency relative to using FULL.

Responses

Response samples

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

Managed CSR: Delete

path Parameters
accountId
required
string
managedCsrId
required
string <uuid>
query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

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