Place Lists

Update Place List

Update a place list by ID.

List-level fields (name, description) are partially updated. If places[] is present, it is treated as the desired full set: omitted places are deleted, matching places are updated in place, and new places are inserted. An empty places[] clears the list. sensitive_location_attestation may be omitted for metadata-only updates and for no-op places[] resubmissions. If the submitted places[] content changes geographic Place content by adding a place, removing a place, or changing an existing place's latitude, longitude, or radius_meters, the API requires sensitive_location_attestation: true; otherwise, the request is rejected. Matched-place name and external_id edits are metadata edits that persist without requiring or recording attestation. version is optional and enables optimistic locking when present.

When changing Place List locations through the API, accepting sensitive_location_attestation: true confirms the following attestation on behalf of the API user for this request:

I represent and warrant that these locations are not being used to
target or identify individuals at sensitive locations, and that I have
the rights and consents necessary for this targeting, including consent
to share with third parties where required.

For guidance on what qualifies as a sensitive location, see Places attestation guidelines.

Geographic-content-changing requests submitted without sensitive_location_attestation, or with it set to any value other than true, are rejected with a 400 invalid-request error on /sensitive_location_attestation. Metadata-only matched-place edits and no-op resubmissions of unchanged Place content do not require or record a new attestation. This is a per-request acknowledgment for actual geographic content changes, not a one-time account-level setting.

The attestation language may be updated over time.

post/place_lists/{place_list_id}

Request

Path parameters

place_list_idinteger required

Numeric ID of the place list to update

Request body

versioninteger

Optional optimistic-lock version. When present, it must match the current Place List version.

namestring
descriptionstring nullable
sensitive_location_attestationboolean

Optional for metadata-only updates and no-op content resubmissions. If submitted places content changes geographic Place content by adding a place, removing a place, or changing an existing place's latitude, longitude, or radius_meters, this field must be true. Matched-place name and external_id edits do not require or record attestation.

Example request

{
  "version": 2,
  "name": "Starbucks Stores - New York",
  "description": "NYC flagship + competitor zones",
  "places": [
    {
      "name": "Times Square",
      "external_id": "STORE-001",
      "latitude": 40.7589,
      "longitude": -73.9851,
      "radius_meters": 1000
    }
  ]
}

Response

Place list response

Example response

{
  "data": {
    "id": 126,
    "entity_type": "place_list",
    "version": 2,
    "organization_id": 100048,
    "name": "Starbucks Stores - New York",
    "description": "NYC flagship + competitor zones",
    "filename": "starbucks_new_york.csv",
    "places_count": 42,
    "places": [
      {
        "id": 5001,
        "name": "Times Square",
        "external_id": "STORE-001",
        "geometry_type": "circle",
        "latitude": 40.7589,
        "longitude": -73.9851,
        "radius_meters": 1000
      }
    ]
  },
  "meta": {
    "status": "success"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.