v1Resources/Locations/postAdd locations to a group

Add locations to a group

Adds locations that are not in a group (409 if one is in another group). They are sent to the directories that support groups right away. Needs access to the added locations' clients, not to every client already in the group.

post/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
addedintegeroptional
Locations added.
locationCountintegeroptional
Locations in the group that the key can see.
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/{groupId}/locations
Your API key
groupId *
Request body*
{}

Guides that use this resource