Actions20
- Administrative API Actions
- List Available Services
- Create New Location Add Request
- Create Existing Location Add Request
- Create Existing Sub Account Add Request
- Cancel Services
- Cancel Sub Account Services
- Cancel All Sub Account Services
- Create Process Review Add Request
- List Add Requests
- Get Add Request
- List Sub Account Add Requests
- Get Sub Account Add Request
- List Services
- List Sub Account Services
- Create Sub Account
- Resources Apply Request
- Get Resources Apply Request Status
- List Accounts
- Get Account
- Update Account
Administrative API → Create New Location Add Request
AI-generatedSummary
Create a new location add request in Yext by specifying the location's ID along with detailed profile data or entity data, including optional account and service sign-up information.
Inputs
- New Location Id (required) — Your ID for the location to be added.
- New Location Account Id — ID for the account where the new location should be created; creates a new account if it does not exist.
- New Location Account Name — Name for a new account if one is created; defaults to the location's name if omitted.
- New Account Parent Account Id — Parent account ID to place the new account under, for multi-layer account structures.
- New Location Data (required) — JSON object specifying the detailed profile data for the location entity to be created (must be provided if not using New Entity Data).
- New Entity Type — Type of entity to create if using New Entity Data, options include location, restaurant, hotel, healthcare facility, etc.
- New Entity Data (required) — JSON string defining the profile content for the new entity for creation (alternative to New Location Data).
- Skus (required) — List of service SKUs to sign the location up for, selected from available services with Location recipient type.
- Agreement Id — Advanced field specifying the Agreement ID under which services will be added; set automatically normally.
- Force Review — Sandbox-only boolean to force the add request into REVIEW status even if it would normally complete successfully.
Output shape
a single JSON response object from Yext API representing the created Add Request, including status and details
The operation returns a single JSON object corresponding to the API response for the add request creation. This includes information about the request status and any identifiers assigned by Yext. Errors will be returned via the node's error handling mechanism.