Skip to main content
POST
/
provider
/
markets
/
{id}
/
areas
Add a geographic area to a market
curl --request POST \
  --url https://api.offergrid.io/provider/markets/{id}/areas \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "operation": "include",
  "label": "<string>",
  "postalCodes": [
    "78701",
    "78702"
  ],
  "postalCountry": "US",
  "adminCountry": "US",
  "adminState": "TX",
  "adminCounty": "Travis",
  "adminCity": "Austin",
  "adminGeoid": "<string>",
  "geometry": {},
  "h3Cells": [
    "<string>"
  ],
  "h3Resolution": 8
}
'

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
​
operation
enum<string>
default:include
Available options:
include,
exclude
​
label
string

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

​
postalCodes
string[]
Example:
["78701", "78702"]
​
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

Response

201 - undefined