Yext Knowledge APIInstall

Summary

Create a new location record in the Yext Knowledge Manager by providing detailed location data including identification, address, contact info, business type, hours, media, and other optional attributes.

Inputs

• Id (required) — Unique alphanumeric ID assigned by the customer as the primary key for the location.
• Account Id (required) — Existing Yext account ID to which this location belongs.
• Location Name (required) — The name of the location adhering to restrictions (no inappropriate language, HTML, URLs, phone numbers, or control characters).
• Location Type (required) — Type of the location (e.g., LOCATION, HEALTHCARE_PROFESSIONAL, RESTAURANT). Affects available fields.
• Address (required) — Valid street address (no P.O. Box) for the location.
• City (required) — City where the location is situated.
• State (required) — State or region code/name for the location.
• Zip (required) — Postal or ZIP code of the location.
• Country Code — Two-character ISO 3166-1 country code; defaults to 'US' if omitted.
• Phone — Valid phone number for the location.
• Hours — Business hours formatted as comma-separated day and time blocks (see description for details).
• Custom Fields — Key-value pairs for custom fields assigned to the location; keys are custom field IDs.
• Category Ids (required) — List of 1 to 10 valid category IDs associated with the location.
• Photos — List of photos (up to 50) with derivatives; comprehensive to avoid unintended removals.
• Emails — Up to five valid email addresses for the location.
• Additional optional fields — Many optional properties related to healthcare, restaurant specifics, social media handles, URLs, advertising, and tracking options are available to enrich location data.

Output shape

a single record

Returns the created location record details and potential warnings if any submitted field values were ignored or invalid.