v1Resources/Locations/patchRename a location group

Rename a location group

The name is the business name customers see on the directories that list the group, so the business there is renamed too. A directory that refuses is listed in `directoryFailures`; the group's name changes anyway, and renaming again retries it. Needs access to every location's client in the group (403 otherwise).

patch/api/v1/location-groups/{groupId}
locations:write
Query parameters
groupIdstringrequired
The location group's id.
Request body
namestringrequired
The business name the locations appear under on the directories that list the group.
Response
dataobjectoptional
renamedbooleanoptional
directoryFailuresarray of objectoptional
Directories that did not take the new name.
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.
patch/api/v1/location-groups/{groupId}
Your API key
groupId *
Request body*
{}

Guides that use this resource