Synup Local SEO API - Getting Started
Locations
- Location Attributes
- Photo specifications for your business location
- Star and Unstar Photos
- Create a new business location
- Update business location
- List all locations
- List particular locations
- Search locations
- Get locations by store codes
- Get Photos by Location IDs
- Upload Photos to a Location
- Check Bulk Photo Upload Status
- Star/Unstar Location Photos
- Delete Location Photos
- Archive multiple locations
- Cancel scheduled location archival
- Activate archived locations
- List Active Subscriptions
- Get a list of supported countries and their states
- Get SubCategories and AdditionalCategories
- Get Site Details for Your Plan
- Location Indexing Rate
- Available advanced filter values
- Download locations
- Filter locations
- Google verification location stats
- Location add-on count
- Location package count
- Available search filter values
Organizing locations
- Organizing locations
- Create a new folder
- List all folders
- List all folders under an account in hierarchical structure
- Get details of a folder
- Rename a folder
- Add locations to a folder
- Remove locations from a folder
- Delete a folder
- List locations under a folder
- List all tags
- List locations by tags
- Add location to a tag
- Remove location from a tag
- Default folder
User Management
- User Attributes
- Create User with Role
- List Users
- List Users by ID
- Add Locations to User
- Add User and folder
- List User Roles
- Add folders to user
- List User Resources
- Update a User
- Remove Folders for User
- Remove Locations for User
Grid Rank
- Local Rank Grid
- Create Rank Grid Report
- Fetch All Grid Reports for Location
- Fetch Rank Grid Report By ID
Review Campaigns
- Review Campaign Info Attributes
- Create a review campaign
- Add customers to a review campaign
- List review campaigns
- List review campaign customers
Listings
- Listings
- Listing Status Webhooks
- Get premium listings
- Get voice listings for a location
- Get duplicate listings for a location
- Get all duplicate listings for an account
- Mark listings as duplicates
- Mark listings as not duplicates
- Get AI listings
Connected Accounts
- Connected Accounts
- Connect Google Profile to Account
- Connect Facebook Page to Account
- Bulk connect link for Apple
- List all connected accounts
- List folders under a Google account
- Create GMB Listing
- Disconnect GMB Profile
- Disconnect Facebook Account
- Fetch Connected Account Details
- Trigger New Matches
- List Connection Suggestions
- Fetch Connected Account Listings
- Confirm Connected Account Matches
- Connect a location with a listing of a connected account
- Disconnect Location from Listing
- create location from connected account listing
- Apple confirmed matches
- Connect link for Apple
- Renew connect link for Apple
Rankings
- Rankings Analytics Attributes
- Add keywords
- List Keywords
- Get keywords performance
- Archive a keyword
- Get Rollup Keyword Performance
- Get Rankings Distribution By Time
Profile Analytics
- Profile Analytics
- Get Bing Analytics
- Get Facebook Page Analytics
- Get Google My Business Analytics
Reviews
- Reviews
- Review Sources
- Fetch all interactions
- List Interactions by IDs
- Respond to an Interaction
- Edit Response for Interaction
- Archive Response for Interaction
- Get Interaction Analytics
- Add Review Widget
- Edit Review Widget
- Rollup Review API
Automations
- Temporary Close Location with a reopening date
Error Codes
- ERROR CODES
Social
- Social Overview
- Create a brand
- Assign a user to a single brand
- Assign multiple brands
Posts
- Posts Overview
- Create an Announcement post
- Create an Event post
- Create an Offer post
- Fetch posts for a location
- Get a single post
- Delete a post
- Create a bulk post
- Fetch a bulk post by ID
- Fetch bulk posts for a location
Menus
- Menus Overview
- Create a menu
- Fetch menus for a location
- Add an item to an existing section
- Update menu currency
- Assign a menu to a location
MCP Server
- Synup MCP — Getting Connected
- Synup MCP — Putting It to Work
Local Post Ideas
- Refresh local ideas
- Suggest local posts for date
- Analyze reference image
- Archive local idea
- Archive local series
- Branch local chat session
- Close local chat session
- Generate all local series posts
- Generate local holiday idea variant
- Generate local series post
- Local active chat session
- Local calendar
- Local chat history
- Local chat sessions
- Local content series detail
- Local content series list
- Local extended config
- Local holiday idea variants
- Local idea job status
- Local image credits
- Local location info
- Local observances
- Local observances with ideas
- Local pipeline status
- Local post idea
- Local post idea counts
- Local post ideas
- Local reference images
- Local scraped context
- Regenerate local idea
- Regenerate local idea content
- Regenerate local idea image
- Schedule local series
- Scrape location
- Send local chat message
- Set location image credits
- Start local chat session
- Switch local chat mode
- Trigger local pipeline
- Update local idea
- Upsert extended location config
Social Post Ideas
- Active chat session
- Analyze reference image
- Archive idea
- Archive series
- Branch chat session
- Brand info
- Calendar
- Chat history
- Chat sessions
- Close chat session
- Content series detail
- Content series list
- Create content series
- Extended brand config
- Generate all series posts
- Generate calendar day
- Generate holiday idea variant
- Generate idea visual
- Generate observance idea
- Generate series post
Schemas
- Schemas
  - FolderSchema
    - Schemas
      - ListFoldersResponse
      - FolderInfo
  - LocationResponseSchema
  - LocationResponseErrorSchema
  - SubCategory
  - SubscriptionsResponse
  - CreateFolderRequest
  - FolderNode
  - ListingsResponse
  - LocationListResponse
  - ConnectGoogleInput
  - ConnectFacebookInput
  - DisconnectGoogleRequest
  - TriggerMatchesRequest
  - FetchListingsRequest
  - ConfirmMatchesRequest
  - ConnectListingRequest
  - DisconnectListingRequest
  - ConnectedAccountDetailsResponse
  - ConnectionSuggestionsResponse
  - Keyword
  - Keyword
  - Keyword
  - UnauthorizedError
  - UnauthorizedError
  - UnauthorizedError
  - UnauthorizedError
  - InsightMetric
  - InsightMetric
  - CreateGridReportInput
  - AllGridReportsResponse
  - GridReportResponse
  - CreateUserInput
  - UsersResponse
  - UsersResponse
  - UsersByIdsResponse
  - AnalyticsOverview
  - Interaction
  - Interaction
  - InteractionsResponse
  - ResponseInteraction
  - AddLocationsInput
  - UserRole
  - UserRole
  - CreateReviewCampaignRequest
  - ReviewCampaignsResponse
  - ReviewCampaignCustomersResponse
  - PremiumListing
  - Subscription
  - CreateFolderResponse
  - Listing
  - ConnectGoogleResponse
  - ConnectFacebookResponse
  - DisconnectGoogleResponse
  - ConnectedAccount
  - TriggerMatchesResponse
  - ConfirmMatchesResponse
  - ConnectListingResponse
  - DisconnectListingResponse
  - Error
  - Error
  - BadRequestError
  - BadRequestError
  - BadRequestError
  - NotFoundError
  - UnauthorizedError
  - UnauthorizedError
  - CreateGridReportResponse
  - GridReport
  - GridReport
  - CreateUserResponse
  - PageInfo
  - PageInfo
  - UserDetail
  - AnalyticsTimeline
  - Response
  - Response
  - PageInfo
  - AddLocationsResponse
  - Pagination
  - Pagination
  - CustomerInput
  - ReviewCampaign
  - ReviewCampaignInfo
  - Tag
  - SearchResponse
  - LocationPhoto
  - CustomAttribute
  - Folder
  - Site
  - ConnectedAccountsResponse
  - LocationListing
  - ListingRecord
  - ConnectionSuggestion
  - NotFoundError
  - NotFoundError
  - RankPoint
  - RankPoint
  - CreatedUser
  - UserEdge
  - UserEdge
  - SiteWiseAnalytics
  - InteractionEdge
  - LocationAddStatus
  - LandingPageTemplate
  - EmailTemplate
  - ReviewCampaignCustomer
  - LocationEdge
  - FetchListingsResponse
  - LocationInfo
  - User
  - User
  - MetricWithDelta
  - Interaction
  - EmailTemplate
  - SmsTemplate
  - SuggestedLocationInfo
  - SMSTemplate
  - CampaignStat
  - ReviewSite
  - BusinessHours
  - AddCustomersRequest
- Business hours
- paymentMethods
- Contact Support
- AppleOauthBulkRequest
- AddKeywordRequest
- AppleConfirmedMatches
- AppleOauthRequest
- AppleRenewOauthRequest
- LocationAdvancedSearchFilterType
- DownloadLocationsInBulkType
- LocationSummaryConnectionType
- GoogleVerificationLocationStats
- LocationAddOnCount
- LocationPackageCount
- LocationSearchFilterType
- DefaultFolderType
- ReferenceImageAnalysis
- ArchiveLocalIdeaRequest
- ArchiveLocalSeriesRequest
- BranchLocalChatSessionRequest
- CloseLocalChatSessionRequest
- GenerateAllLocalSeriesPostsRequest
- GenerateLocalHolidayIdeaVariantRequest
- GenerateLocalSeriesPostRequest
- LocalCalendarDay
- LocalContentSeries
- ExtendedLocationConfig
- LocalIdeaJobStatus
- LocalLocationInfo
- LocalObservance
- LocalObservanceWithIdea
- LocalPipelineStatus
- LocalPostIdea
- ReferenceImageOption
- PostIdeaCounts
- ScrapedLocationContext
- RefreshLocalIdeasRequest
- RegenerateLocalIdeaRequest
- RegenerateLocalIdeaContentRequest
- RegenerateLocalIdeaImageRequest
- ScheduleLocalSeriesRequest
- ScrapeLocationRequest
- SendLocalChatMessageRequest
- SetLocationImageCreditsRequest
- StartLocalChatSessionRequest
- SuggestLocalPostsForDateRequest
- SwitchLocalChatModeRequest
- TriggerLocalPipelineRequest
- UpdateLocalIdeaRequest
- UpsertExtendedLocationConfigRequest
- ChatSession
- ArchiveIdeaRequest
- ArchiveSeriesRequest
- BranchChatSessionRequest
- BrandInfo
- CalendarDay
- ChatMessage
- CloseChatSessionRequest
- ContentSeries
- CreateContentSeriesRequest
- ExtendedBrandConfig
- GenerateAllSeriesPostsRequest
- GenerateCalendarDayRequest
- GenerateHolidayIdeaVariantRequest
- GenerateIdeaVisualRequest
- GenerateObservanceIdeaRequest
- GenerateSeriesPostRequest
- AppleOauthBulkPayload
- CoordinateInput
- AppleConfirmedMatch
- AppleOauthPayload
- AppleRenewOauthPayload
- LocationSummaryEdge
- AddOnCount
- SitePublisherCategory
- LocalMutationResponse
- LocalChatSessionResponse
- LocalGenerateIdeasResponse
- LocalRegenerateResponse
- LocalImageCredits
- LocalTriggerPipelineResponse
- LocalScheduleSeriesResponse
- LocalChatMessageResponse
- MutationResponse
- ChatSessionResponse
- GenerateAllSeriesPostsResponse
- RegenerateResponse
- PageInfo
- Error
- MutationError
- AddKeywordResult
- LocalError
- LocalChatSession
- LocalChatMessage
- ActionChip

ChatMessage

{
    "id": "string",
    "role": "string",
    "content": "string",
    "messageType": "string",
    "metadata": {},
    "sequence": 0,
    "createdAt": "string"
}