v1Resources/Locations/postCreate a location group

Create a location group

Lists 2 or more locations together under one name. Any of the key's locations can be grouped, across clients of the agency; a shared phone number is the usual reason, not a requirement. Each location must not already be in a group (409). The locations are sent to the directories that support groups right away and listed under one business there. Get the exact locations confirmed by a person before calling this.

post/api/v1/location-groups
locations:write
Request body
namestringrequired
The business name the locations appear under on the directories that list the group.
locationIdsarray of stringrequired
Location ids or public ids.
Response
dataobjectoptional
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/location-groups
Your API key
Request body*
{}

Guides that use this resource