HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Create Proximity Segment Definition

🚧

This endpoint is in beta and subject to change.

A beta revision header (2026-10-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our versioning and deprecation policy for more information.

Build a segment definition that targets profiles near a location.

Nothing is created or stored. Pass the returned name and definition to POST /api/segments, then link the result with POST /api/locations/{id}/relationships/segments.

The definition matches on the location's postal code and country, so a location missing either cannot produce one.

Rate limits:
Burst: 10/s
Steady: 150/m

Scopes:
locations:read
segments:read

OpenAPI Spec

Query Params
fields[proximity-segment-definition]
array of strings
fields[proximity-segment-definition]
Allowed:
Body Params

Request to build a proximity segment definition seeded from a location.

data
object
required
Headers
string
required
Defaults to 2026-10-15.pre

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/vnd.api+json