v1Resources/Connections/postCreate Google listings

Create Google listings

Queues a new Google Business Profile for each location in the selection that can get one. This is the API version of Create Google listings in Location Manager, and it is the last step of the flow: call preview with locationIds to see readiness and the usable logins, list a login's groups with destinations, call preview again with accountConnectionId and googleAccountName until canSubmit is true, then send the same body here. Everything is checked again on this call, so an earlier preview is not trusted. Locations in the ready or review state are queued, and the rest come back in skipped. confirmedNoExistingProfiles must be true, or the request returns 400. A 202 means the work is queued, not that the profiles exist yet: creation runs in the background and can be retried or fail, so poll the status endpoint. Returns 409 when the login or group can't be used for this selection, or when none of the locations can be created.

post/api/v1/connections/google-listing-create
connections:write
Request body
locationIdsarray of stringrequired
The ids of the locations to work on, up to 200. Duplicates are ignored.
accountConnectionIdstringrequired
The connectionId of the Google login to create under, from accounts in the preview response. Required for destinations and create. Optional for preview, where you send it with googleAccountName to check a destination.
googleAccountNamestringrequired
The resourceName of the Google group to create the listings in, such as accounts/123456789, from the destinations response. Required for create. Optional for preview.
confirmedNoExistingProfilesboolean (true)required
Must be true. Confirms that these businesses need new Google profiles and don't already have one. Any other value returns 400.
Response
dataobjectoptional
resultsarray of objectoptional
One entry for each location that create tried to queue.
locationIdstringoptional
The location's id.
outcomestring (queued | blocked | failed_to_queue)optional
queued (the create is on its way), blocked (it wasn't allowed, see reason) or failed_to_queue (something went wrong on our side, so try again).
connectionIdstringoptional
The location's new pending Google connection. Only present when queued.
orderItemIdstringoptional
The id of the order that runs the create. Only present when queued.
reasonstringoptional
Why the location wasn't queued: submission_not_allowed, a plan limit code (feature_disabled, location_limit, connection_limit, cancellation_pending or entitlement), or internal_error. Absent when queued.
skippedarray of objectoptional
Selected locations that weren't queued because they are excluded or need attention, with the same fields as locations in the preview response.
locationIdstringoptional
The location's id.
clientIdstringoptional
The client the location belongs to, or null.
namestringoptional
The location's business name, or null.
statestring (ready | review | needs_attention | excluded)optional
ready (can be created), review (can be created, but check it first because Google may already have a profile for it), needs_attention (fix the location, then preview again) or excluded (won't get a new Google listing).
reasonsarray of string (archived | already_connected | creating | needs_reconnection | google_excluded_by_package | opted_out | missing_business_name | missing_google_category | missing_address | possible_existing_profile | previously_connected)optional
Why the location is in this state. Excluded: archived, already_connected, creating (a create is already in progress), needs_reconnection (linked to a Google listing whose access has expired), google_excluded_by_package (Google isn't part of the location's listing package) or opted_out. Needs attention: missing_business_name, missing_google_category or missing_address (no street, city and country, and no service area). Review: possible_existing_profile (a Google listing found under one of your logins matches this location) or previously_connected (the location was linked to Google before and has been disconnected). Empty for a ready location.
unavailableIdsarray of stringoptional
Requested location ids that weren't found or that you can't access. They are listed here instead of failing the request.
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.
409Nothing was queued. The response's code is invalid_destination when the login or group can't be used for this selection, or invalid_request when none of the selected locations can be created. Run preview to see why.
429Too many requests. Retry after the number of seconds in the Retry-After header.
502Google couldn't be reached to read the login's groups. Try again later. The response's code is provider_unavailable.
post/api/v1/connections/google-listing-create
Your API key
Request body*
{}

Guides that use this resource