1. Social
  • Synup Local SEO API - Getting Started
  • Locations
    • Location Attributes
      MARKDOWN
    • Photo specifications for your business location
      MARKDOWN
    • Star and Unstar Photos
      MARKDOWN
    • Create a new business location
      POST
    • Update business location
      POST
    • List all locations
      GET
    • List particular locations
      GET
    • Search locations
      GET
    • Get locations by store codes
      GET
    • Get Photos by Location IDs
      GET
    • Upload Photos to a Location
      POST
    • Check Bulk Photo Upload Status
      GET
    • Star/Unstar Location Photos
      POST
    • Delete Location Photos
      POST
    • Archive multiple locations
      POST
    • Cancel scheduled location archival
      POST
    • Activate archived locations
      POST
    • List Active Subscriptions
      GET
    • Get a list of supported countries and their states
      GET
    • Get SubCategories and AdditionalCategories
      GET
    • Get Site Details for Your Plan
      GET
    • Location Indexing Rate
      GET
    • Available advanced filter values
      GET
    • Download locations
      GET
    • Filter locations
      GET
    • Google verification location stats
      GET
    • Location add-on count
      GET
    • Location package count
      GET
    • Available search filter values
      GET
  • 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
      • Get a list of interaction sources for location
      • Get a list of interaction sources for account
      • Add / Edit interaction source
    • 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
      POST
    • Assign a user to a single brand
      PUT
    • Assign multiple brands
      PUT
  • 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
    • Holiday idea variants
    • Idea job status
    • Image credits
    • Link post idea to social post
    • Observances
    • Observances with ideas
    • Pipeline status
    • Post idea
    • Post idea counts
    • Post ideas
    • Reference images
    • Refresh ideas
    • Regenerate idea
    • Regenerate idea content
    • Regenerate idea image
    • Schedule series
    • Scrape brand
    • Scraped brand context
    • Send chat message
    • Series posts
    • Set brand image credits
    • Start chat session
    • Suggest posts for date
    • Switch chat mode
    • Trigger pipeline
    • Update extended brand config
    • Update idea
  • Webhooks
    • Synup Webhooks
    • Webhooks
      • Directory listing synced (success/incomplete)
      • New review received for a location
      • New response to a review received
      • Listing connected
      • Listing disconnected
      • Listing re-authorization required
      • Listing became inaccessible
      • Google verification passed
      • Google verification failed
      • Location created
      • Location updated
      • Location deleted
      • Share-of-Voice snapshot completed
      • Grid rank report ready
      • Daily review analytics snapshot
      • Weekly review analytics snapshot
      • Review campaign sent
      • Campaign recipients added
      • Campaign message status changed
      • Campaign feedback submitted
      • Campaign message send rejected
      • Review posted (campaign-attributed)
      • Social post created
      • Social post published
      • Social post deleted
      • Social post rejected
      • Social post failed
      • Boost created
      • Boost active
      • Boost rejected
      • Boost stopped
      • Social channel connected
      • Social channel disconnected
      • Social channel archived
      • Ad account status changed
      • AI post idea generated
      • AI idea scheduled as post
      • AI idea series completed
      • AI idea scrape completed
      • AI idea scrape failed
      • AI idea image generated
      • AI idea image generation failed
    • Endpoint verification handshake
  • 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
    • ArchiveIdeaRequest
    • ArchiveSeriesRequest
    • BranchChatSessionRequest
    • BrandInfo
    • CalendarDay
    • CloseChatSessionRequest
    • ContentSeries
    • CreateContentSeriesRequest
    • ExtendedBrandConfig
    • GenerateAllSeriesPostsRequest
    • GenerateCalendarDayRequest
    • GenerateHolidayIdeaVariantRequest
    • GenerateIdeaVisualRequest
    • GenerateObservanceIdeaRequest
    • GenerateSeriesPostRequest
    • LocationConnectedEvent
    • IdeaJobStatus
    • ImageCredits
    • LinkPostIdeaToSocialPostRequest
    • Observance
    • ObservanceWithIdea
    • PipelineStatus
    • PostIdea
    • RefreshIdeasRequest
    • RegenerateIdeaRequest
    • RegenerateIdeaContentRequest
    • RegenerateIdeaImageRequest
    • ScheduleSeriesRequest
    • ScrapeBrandRequest
    • ScrapedBrandContext
    • SendChatMessageRequest
    • SetBrandImageCreditsRequest
    • StartChatSessionRequest
    • SuggestPostsForDateRequest
    • SwitchChatModeRequest
    • TriggerPipelineRequest
    • UpdateExtendedBrandConfigRequest
    • UpdateIdeaRequest
    • AppleOauthBulkPayload
    • CoordinateInput
    • AppleConfirmedMatch
    • AppleOauthPayload
    • AppleRenewOauthPayload
    • LocationSummaryEdge
    • AddOnCount
    • SitePublisherCategory
    • LocalMutationResponse
    • LocalChatSessionResponse
    • LocalGenerateIdeasResponse
    • LocalRegenerateResponse
    • LocalImageCredits
    • LocalTriggerPipelineResponse
    • LocalScheduleSeriesResponse
    • LocalChatMessageResponse
    • MutationResponse
    • ChatSessionResponse
    • GenerateAllSeriesPostsResponse
    • RegenerateResponse
    • LinkPostIdeaToSocialPostResponse
    • TriggerPipelineResponse
    • ScheduleSeriesResponse
    • ChatMessageResponse
    • GenerateIdeasResponse
    • PageInfo
    • Error
    • MutationError
    • AddKeywordResult
    • LocalError
    • LocalChatSession
    • LocalChatMessage
    • ChatSession
    • ChatMessage
    • ActionChip
  1. Social

Social Overview

Overview#

This API provides Social Brand management, enabling businesses to create and manage their social media presence. A brand represents a social profile tied to a business, with attributes such as name, category, and business intent. Users can be assigned to brands to manage access.

Social Brands API Attributes#

Given below are the response fields returned for the API endpoints in Social Brands.

Create a brand#

NameField TypeDescription
idStringThe unique ID of the created brand
nameStringThe name of the brand (required)
businessIntentStringThe primary intent of the business, e.g. LOCAL_BUSINESS (required)
categoriesArrayThe list of categories the brand belongs to (required)
websiteStringThe website URL of the brand
phoneStringThe contact phone number for the brand
descriptionStringA description of the brand
profileImageUrlStringURL of the brand's profile image
coverImageUrlStringURL of the brand's cover image

Assign a user to a brand#

NameField TypeDescription
socialProfileIdsArrayThe list of brand IDs the user is being assigned to. Derived from the URL — supports a single ID or multiple comma-separated IDs
userIdStringThe ID of the user to assign to the brand(s)

Modified at 2026-04-13 05:17:30
Previous
ERROR CODES
Next
Create a brand
Built with