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

Trigger New Matches

This API fetches all locations from connected Google My Business and Facebook Page profiles and attempts to match them with locations in your account.

Behavior:

  • Supports batch processing – multiple connected accounts can be processed in a single request.
  • Matches locations based on business name, address, and other identifying attributes.
  • Helps ensure consistency between external platforms and your account.
Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Headers

NameTypeRequiredDescription
Content-Typestringrequired

Body

NameTypeRequiredDescription
inputobjectrequired
input.connectedAccountIdsarray of stringrequiredList of connected account IDs to process

Request

Request
curl -X POST 'https://api.synup.com/api/v4/connected-accounts/trigger-matches' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "input": {
    "connectedAccountIds": [
      "6eb312f7-df32-4d76-ad8a-26bcfeab601e",
      "7eb3q2f7-df34-4dt6-hd88-269cfoal6m1b"
    ]
  }
}'

Responses

StatusDescription
200Match triggering process initiated
400Invalid request - Missing or invalid parameters
401Unauthorized - Invalid or missing API key
403Forbidden - Insufficient permissions
Example response (generated from the schema)
{
  "data": {
    "connectedAccountsTriggerMatches": {
      "success": true,
      "failedIds": [
        "7eb3q2f7-df34-4dt6-hd88-269cfoal6m1b"
      ]
    }
  }
}

Response body

NameTypeRequiredDescription
dataobjectoptional
data.connectedAccountsTriggerMatchesobjectoptional
data.connectedAccountsTriggerMatches.successbooleanrequiredIndicates if all connected accounts were processed successfully. Returns false if any account failed to process.
data.connectedAccountsTriggerMatches.failedIdsarray of stringoptionalList of connected account IDs that failed to process