Skip to main content
POST
Add a geographic area to a market

Authorizations

x-api-key
string
header
required

Team API key for authentication. Your team role (provider/reseller/hybrid) determines which endpoints you can access.

Path Parameters

id
string
required

Body

application/json
type
enum<string>
required
Available options:
postal,
admin,
polygon,
h3,
utility_territory,
serviceability
operation
enum<string>
default:include
Available options:
include,
exclude
label
string

Optional display label (e.g. "Travis County", "78704 cluster").

postalCodes
string[]
Example:
postalCountry
string
Example:

"US"

adminLevel
enum<string>
Available options:
state,
county,
city,
census_place
adminCountry
string
Example:

"US"

adminState
string
Example:

"TX"

adminCounty
string
Example:

"Travis"

adminCity
string
Example:

"Austin"

adminGeoid
string

Census GEOID for stable matching.

geometry
object

GeoJSON Polygon or MultiPolygon.

h3Cells
string[]
h3Resolution
number
Example:

8

utilityCodes
string[]

TDSP/TDU DUNS codes, e.g. Oncor "1039940674000".

Example:
utilityCountry
string
Example:

"US"

sourceType
enum<string>
Available options:
fabric_upload,
external_api
sourceRef
string

The IntegrationSource key this area resolves through. Required for serviceability areas, where it must name an active serviceability source owned by your team.

gating
boolean
default:false

Serviceability areas only. true = the market covers an address only when this source answers on-net; false (default) = the source enriches offer detail but never hides the offer. An unanswerable lookup never gates.

Response

201 - undefined