Yext Admin API icon

Yext Admin API

Interact with Yext Admin API

Administrative API → Create Existing Location Add Request

AI-generated

Summary

Create a location add request to sign up an existing Yext location for additional services specified by SKUs.

Inputs

  • Existing Location Id (required) — ID of the existing location to add services for; it must already exist in your account or sub-accounts if using the Partner Portal.
  • Existing Location Account Id — (Partner Portal only) Identifies which sub-account contains the existing location if the location ID is not unique among sub-accounts.
  • Skus (required) — JSON array of SKUs representing the services to add to the location, chosen from the Available Services list with recipientType 'Location'.
  • Agreement Id — (Advanced) The agreement ID under which services will be added; usually set automatically and should only be manually set if managing multiple active agreements.
  • Force Review — (Sandbox API only) If true, forces the add request into REVIEW status even if it would otherwise complete successfully.

Output shape

a single record representing the response from creating the location add request

The operation submits a request body containing the specified fields to the Yext Admin API and returns the response as a JSON object. Supports optional request settings like batching, timeout, proxy, and SSL handling.

Discussion