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

Confirm Connected Account Matches

This API confirms suggested matches between locations in your account and profiles from Google My Business or Facebook Pages that were previously recommended.

Behavior:

  • Requires base64-encoded match record IDs in a specific format, depending on the account type.
  • Once confirmed, the system links the location with the external listing for ongoing management.
Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Headers

NameTypeRequiredDescription
Content-Typestringrequired

Body

NameTypeRequiredDescription
inputobjectrequired
input.matchRecordIdsarray of stringrequiredArray of base64 encoded match record IDs. For GMB accounts: Encode GmbLocationMatchedData:{matchedDataDatabaseId} For FB accounts: Encode FbLocationMatchedData:{matchedDataDatabaseId}

Request

Request
curl -X POST 'https://api.synup.com/api/v4/connected-accounts/confirm-matches' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "input": {
    "matchRecordIds": [
      "R21iTG9jYXRpb25NYXRjaGVkRGF0YTplNGZhNTFkYi04NWEwLTRjYzItYjdmMS01OWNhMzQ1NjlhZWM=",
      "R21iTG9jYXRpb25NYXRjaGVkRGF0YSI6MWFjMDdiN2ItMjUyYi00NTdkLTlhM2ItMTk4NzEzYzNkZjQz"
    ]
  }
}'

Responses

StatusDescription
200Match confirmation process completed
400Invalid request - Malformed base64 strings or invalid format
401Unauthorized - Invalid or missing API key
403Forbidden - Insufficient permissions
Example response (generated from the schema)
{
  "data": {
    "confirmConnectMatches": {
      "success": true,
      "failedIds": [
        "e4fa51db-85a0-4cc2-b7f1-59ca34569aec"
      ]
    }
  }
}

Response body

NameTypeRequiredDescription
dataobjectoptional
data.confirmConnectMatchesobjectoptional
data.confirmConnectMatches.successbooleanrequiredIndicates if all match records were confirmed successfully. Returns false if any match failed to confirm.
data.confirmConnectMatches.failedIdsarray of stringoptionalList of original (non-encoded) match record IDs that failed to confirm. Only present when some matches fail.