en
Catalog›Define a territory the business serves

Define a territory the business serves

Creates a service area: a named region used as a HARD filter when deciding who can take a job. A technician assigned to no area covering the job's address is never offered by listNearbyTechnicians, listMatchingSlots or listCrewCandidates, and never auto-assigned at confirm, whatever their skills or availability say. `name` is the only required field and must be unique (SERVICE_AREA_DUPLICATE_NAME). Coverage is matched two ways: with a `boundary` (GeoJSON polygon), a geocoded address must fall inside the polygon; without one, the area matches addresses by equality on its postal_code, city or district. A polygon is the precise option; the administrative fields are the fallback, and also what matches jobs whose address could not be geocoded. An invalid polygon is refused with SERVICE_AREA_INVALID_BOUNDARY. Creating the area does not staff it. Assign technicians with replaceTechnicianServiceAreas, or pass `service_area_ids` to createTechnician. Send an Idempotency-Key header (the `idempotency_key` argument over MCP) so a retry does not create a duplicate area.

Arguments

Idempotency-Keystringheaderoptional
Unique key making retries safe: a repeat send with the same key replays the original response (header Idempotent-Replayed: true) instead of re-running the operation. Reusing a key with a different body returns 422 IDEMPOTENCY_KEY_REUSE.
boundaryobjectbodyoptional
GeoJSON polygon boundary (optional)
citystringbodyoptional
City name
countrystringbodyoptional
Country name
countystringbodyoptional
County name
descriptionstringbodyoptional
Optional description
districtstringbodyoptional
District name
namestringbodyrequired
Area name (required)
postal_codestringbodyoptional
Postal code
state_provincestringbodyoptional
State / province name
POST/v1/service-areas
curl -X POST "https://api.crisphive.com/v1/service-areas" \
  -H "Authorization: Bearer chsk_test_4eC8xQ9mZ2pL7Ka0rT" \
  -H "Content-Type: application/json" \
  -d '{
  "boundary": {},
  "city": "New York",
  "country": "United States",
  "county": "New York County",
  "description": "Main service area covering downtown",
  "district": "Manhattan",
  "name": "Downtown Area",
  "postal_code": "10001",
  "state_province": "New York"
}'
Request body
{
"boundary": {
},
"city": ,
"country": ,
"county": ,
"description": ,
"district": ,
"name": ,
"postal_code": ,
"state_province":
}

Responses