v1Resources/Connections/postConfirm a suggested match
Confirm a suggested match
Confirms a NAP-scoring suggestion, creating a location-level connection from a fetched listing already matched to a Synup location. Fails if the listing has no matched location (400), is already connected (409), or the location already has a connection on that platform (409).
post
connections:write/api/v1/connections/locations/confirm-matchRequest body
fetchedListingIdstringrequired
The fetched listing to confirm. Required.
Response
dataobjectoptional
idstringoptional
Unique identifier for the resulting connection.
platformstring (google | facebook)optional
The platform the listing was paired on.
synupLocationIdstringoptional
The location's legacy Synup id, or null for a native location.
clientLocationIdstringoptional
The location's id.
platformResourceNamestringoptional
The listing's resource name/id on the platform.
platformPageNamestringoptional
The listing's display name on the platform.
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
409The request conflicts with the current state of the resource — for example, changing the email or phone of a recipient who has already been messaged, or a team invite that was already accepted (or hasn't been accepted yet).
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/connections/locations/confirm-match
Your API key
Request body*
{
"data": {
"id": "listing_1",
"platform": "google",
"synupLocationId": null,
"clientLocationId": "loc_456",
"platformResourceName": "accounts/123/locations/456",
"platformPageName": "Acme Dental — Downtown"
}
}