Skip to content
SynupAPI
Get an API key
POSTapi.synup.com/api/v4/connected-accounts/connect-listing

Connect a location with a listing of a connected account

This API links a location in your account with a listing from a connected Google My Business or Facebook Page account.

Required Fields:

  • locationId – Base64-encoded unique identifier of the location.
  • connectedAccountListingId – The ID of the listing, retrieved from the Fetch Listings API.
  • connectedAccountId – The ID of the connected account managing the listing.

Behavior:

  • Establishes a direct connection between the location and the listing.
  • Enables the system to sync and manage the listing’s data.
Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Headers

NameTypeRequiredDescription
Content-Typestringrequired

Body

NameTypeRequiredDescription
inputobjectrequired
input.locationIdstringrequiredBase64 encoded location ID
input.connectedAccountIdstringrequiredID of the connected account
input.connectedAccountListingIdstringrequiredID of the listing from the fetch listings API response. This is typically a base64 encoded string.

Request

Request
curl -X POST 'https://api.synup.com/api/v4/connected-accounts/connect-listing' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "input": {
    "locationId": "TG9jYXRpb246NzM5MzM=",
    "connectedAccountId": "3db66afa-151d-4212-a8b7-949f9fe9aaf9",
    "connectedAccountListingId": "R21iQnVsa0RhdGFMYWtlOmMyMWRiOWY5LTZmYTctNDE0My1hNDU2LTQzMjZkMmZiN2UwZg=="
  }
}'

Responses

StatusDescription
200Connection process completed
400Invalid request - Malformed base64 string or invalid IDs
401Unauthorized - Invalid or missing API key
403Forbidden - Insufficient permissions
404Not Found - Location or listing not found
Example response (generated from the schema)
{
  "data": {
    "connectListing": {
      "success": true,
      "message": "Internal System Error"
    }
  }
}

Response body

NameTypeRequiredDescription
dataobjectoptional
data.connectListingobjectoptional
data.connectListing.successbooleanrequiredIndicates if the connection was successful
data.connectListing.messagestringoptionalError message if the connection failed. Returns null on successful connection.