v1Resources/Locations/deleteRemove locations from a group

Remove locations from a group

Takes locations out of the group. On each directory that lists the group, the location is deleted from under the group's business and its listing there (and on the regional sites that copy it) is cleared, so it is sent again on its own. If it shares a phone number with other locations, that directory may refuse it again. A location a directory could not remove is returned in `directoryFailures` and stays in the group.

delete/api/v1/location-groups/{groupId}/locations
locations:write
Query parameters
groupIdstringrequired
The location group's id.
Request body
locationIdsarray of stringrequired
Location ids or public ids.
Response
dataobjectoptional
removedintegeroptional
Locations taken out of the group.
directoryLocationsDeletedintegeroptional
Locations deleted from under the group's business on directories.
directoryFailuresarray of objectoptional
Locations a directory could not remove; they stay in the group.
locationIdstringoptional
sitestringoptional
reasonstringoptional
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.
429Too many requests. Retry after the number of seconds in the Retry-After header.
delete/api/v1/location-groups/{groupId}/locations
Your API key
groupId *
Request body*
{}

Guides that use this resource