Contents

Update Location Group

Update an existing location group’s name, rules, or location membership.

URL

PUT https://api.ads.apple.com/v1/location-groups/{id}

Path Parameters

NameTypeDescription
id Requiredstring

Header Parameters

NameTypeDescription
X-Ap-Context Requiredstring

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
LocationGroupResponse
400Bad Request
Content-Type: application/json
LocationGroupResponse
401Unauthorized
Content-Type: application/json
Error
403Forbidden
Content-Type: application/json
LocationGroupResponse
404Not Found
Content-Type: application/json
LocationGroupResponse
429Too Many Requests
Content-Type: application/json
Error
500Internal Server Error
Content-Type: application/json
Error

Discussion

The system modifies only the fields you include in the request body. Omitted fields retain their current values. See LocationGroupUpdate for the request body’s accepted fields, including which ones are mutable.

The brandId and adAccountId fields can’t change after creation, and the update request body doesn’t accept them. To move a group to a different brand or transfer ownership to another ad account, delete the group and recreate it.

The locationIds and rules fields use full-replacement semantics: the value you send becomes the entire list, not a diff against the existing one, since the API doesn’t support partial updates within an array. To add a single location to a STATIC group, retrieve the current locationIds array, append the new ID, and send the complete list.

When you add or update rules on a DYNAMIC group, systemStatus transitions to PENDING while the system evaluates membership, and groupTotal keeps its last known value until evaluation completes. Updating only name or description leaves systemStatus, groupTotal, and membership unchanged. Because an ad group displays the place card for each location in its assigned location group, changing a group’s membership changes which place cards appear once evaluation (if triggered) completes.

Payload Examples

See Also