GuideGuides
Developer guides
Problem-first guides for building on the Synup API: what to call, in what order, with complete examples you can run. Each guide links to the endpoint reference it uses.
Guides
- Business Listings API: Complete Developer GuideHow a business listings API works and how to create, update, sync and monitor locations across Google, Apple, Bing and directories with the Synup API.
- How to Manage Business Listings ProgrammaticallyKeep business listings accurate from your own system with the Synup API. Covers change detection, idempotent updates, hours, photos and sync reporting.
- How to Update Business Information Across Google, Apple, Bing and DirectoriesPush one business-information change to Google, Apple, Bing and the directory network through a single API call, and verify it reached each publisher.
- How to Manage Thousands of Business Locations via APIDesign a sync job for thousands of locations on the Synup API with cursor pagination, tags, rate-limit handling, an id map and rollup health checks.
- How to Find and Remove Duplicate Business ListingsDetect duplicate business listings across publishers, review them by confidence, and flag them for removal or dismiss them with the Synup API.
- How to Connect and Manage Google Business Profiles via APIConnect a Google Business Profile to a location, match the account's listings, keep the profile in sync and handle reconnects with the Synup API.
- How to Fetch and Respond to Reviews via APIFetch reviews from Google, Facebook and custom review sites, filter them, post owner replies, add internal notes and read review analytics with the Synup API.
- How to Build Automated Review-Response WorkflowsBuild a review-response workflow that routes reviews by rating and sentiment, drafts replies, approves them, and pushes them back to the platform.
- How to Publish Google Business Profile Posts ProgrammaticallyPublish announcements, offers and events to Google Business Profile via API, schedule them, handle the missing-connection draft, and measure post performance.
- How to Retrieve Google Business Profile Analytics via APIPull Google Business Profile analytics through an API, portfolio-wide and per location, with views, calls, direction requests and a maps-versus-search split.
- How to Track Local Rankings with an APITrack local search rankings on a geo grid through an API, add keywords, read the grid and trend, and compare against competitors and citation coverage.
- How to Monitor Local SEO Across Multiple LocationsMonitor local SEO across hundreds of locations through rollup endpoints, with rank and AI visibility per location and the weakest surfaced first.
- How to Track AI and AEO Visibility ProgrammaticallyMeasure how ChatGPT, Gemini and Perplexity describe and recommend a business through an API, enqueue reports, poll for results and roll up a portfolio.
Build with Synup
- How to Build a Reputation Management PlatformArchitecture and API calls for a multi-client reputation management platform on Synup: review ingestion, reply workflows, invites, widgets and reporting.
- How to Add Local Marketing Features to Your SaaSAdd listings management, reviews, Google posts, profile analytics, rank tracking and AI visibility to a SaaS product with the Synup API, tenant by tenant.
- How to Build an AI Agent for Local SEOBuild an AI agent that audits and fixes listings, tracks local rankings, checks AI visibility and drafts review replies with Synup's MCP server or REST tools.
- How to Build an AI Agent That Responds to ReviewsBuild an AI agent that drafts and posts review replies, with rating-based guardrails, human approval for negatives, and protection against injection.
- How to Build a White-Label Local Marketing PlatformBuild a multi-tenant white-label local marketing platform on the API, with client provisioning, team access, per-client summaries and scoped API keys.
- How to Build a Multi-Location Marketing DashboardBuild a multi-location marketing dashboard from the API's rollup endpoints, one call per panel, covering listings, reviews, rank, AI visibility and duplicates.
- How to Add Local Marketing Functionality to Vertical SaaSAdd local marketing to a vertical SaaS by mapping existing customers to clients and locations, and shipping only the features your niche needs.
Recipes
- Create a Location with the Synup APICreate a business location under a client in one POST, get back a locationId, and know which fields matter and which can wait.
- Update a Location's Opening Hours via APISet a weekly schedule with the Synup API, handle split shifts and 24-hour days, and avoid the read-versus-write time format that breaks naive diffs.
- Temporarily Close a Business Location via APIMark a location closed for a holiday or a renovation with specialHours, and why you must not use archival for a temporary closure.
- Upload Business Photos via APIAdd photos to a location by category with the Synup API, from a public URL or base64, and avoid uploading the same image twice on a schedule.
- Detect Duplicate Business Listings via APIRead the duplicate queue across a client with the Synup API, sort by confidence, and know why the match score beats the individual match flags.
- Suppress a Duplicate Listing via APIFlag a duplicate listing for removal with one Synup API call, by explicit ids or by filter, and what the flagged, deleted and failed states mean.
- Fetch Recent Reviews via APIPull a location's reviews from every connected platform with the Synup API, filter to what needs attention, and page through with a cursor.
- Respond to a Review via APIPost an owner reply to a review with the Synup API, read the push status back, and know which failures are worth a retry.
- Publish a Google Business Profile Post via APIPublish an announcement, offer or event to a location's connected platforms, and handle the draft returned when a platform is not connected.
- Retrieve Profile Analytics via APIPull Google Business Profile analytics with the Synup API, portfolio-wide or per location, with views, actions, calls and direction requests.
- Fetch Local Keyword Rankings via APITrack local search rankings on a geo grid with the Synup API, add keywords for a location, and read the rank trend once the background scan lands.
- Send a Review Invite via APIAdd a customer to a review-invite campaign with the Synup API once a visit completes, and the domain and number verification that gating requires.
Concepts
- What Is a Business Listings API?A business listings API manages a business's name, address, hours and more across many publishers at once, with sync status and duplicate detection built in.
- Google Business Profile API vs a Listings Management APIHow Google's Business Profile API compares with a listings management API on scope, access, sync status, duplicates and reviews, and when to use each.
- What Is a Local SEO API?A local SEO API measures how a business ranks in local search, with geo-grid rank tracking, profile analytics and AI visibility, not just backlinks.
- What Is an AEO API?An AEO API measures how AI answer engines like ChatGPT, Gemini and Perplexity describe and recommend a business, and tracks that visibility over time.
- How Listing Syndication WorksListing syndication takes one business record, translates it into each publisher's format, and pushes it out asynchronously, which is why sync status matters.
- How Google Business Profile Synchronization WorksGoogle Business Profile sync rests on an owner's OAuth consent, matching a location to the right Google listing, then a write-and-verify loop.
- How Duplicate Listing Suppression WorksDuplicate suppression detects listings that look like the same business, scores them by confidence, and requests removal from the publisher that controls them.
- Building Publisher Integrations Directly vs Using SynupWhat it really costs to integrate Google, Apple, Bing and directories yourself, versus one API, and how to decide between them or combine both.
- Local SEO APIs: What Developers Actually NeedA practical checklist of what a local SEO API must cover, from listings and sync status to reviews, rank tracking and AI visibility, mapped to endpoints.