MEmediamath
Place Lists

Create Place List

Create a place list with inline circle places.

Only circle places are supported. API users must provide latitude, longitude, and radius_meters for each place. geometry_type is returned by the API and must not be supplied by users.

Before creating Place List locations through the API, API users must accept the sensitive-location attestation by including sensitive_location_attestation: true in the request body. Accepting this field 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.

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. This is a per-request acknowledgment, not a one-time account-level setting.

The attestation language may be updated over time.

post/place_lists

Request

Request body

organization_idinteger required
namestring required
descriptionstring nullable
sensitive_location_attestationtrue required

Required and must be true for Place List content writes.

Example request

{
  "organization_id": 100048,
  "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.