Check Service Area
check_service_areaCheck a service ZIP, or a Massachusetts town, city or neighborhood name on its own, against the coverage database for Norfolk, Suffolk and Plymouth counties. Answer "do you serve ?" directly with town (no ZIP needed): covered = yes; partially_covered = yes for the listed covered_zips, confirm the customer's ZIP only then; outside_service_area = not in the automatic-booking area (offer request_out_of_area_callback and the office number); unknown_town = ask for the ZIP. During new-customer intake run this check silently; never announce that you are checking the service area. Unavailable coverage is unknown, not outside-area. This never proves that a particular appointment is available.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| zip | No | Five-digit service ZIP (ZIP+4 accepted). Town name alone is enough; pass a ZIP only when the town result is partially_covered or unknown_town, or when the customer already gave the full address. Send zip or town; an empty call returns LOCATION_REQUIRED. | |
| town | No | Massachusetts town, city or neighborhood name on its own, e.g. "Quincy" or "Dorchester". Answers "do you serve <town>?" directly; do not demand a ZIP first. | |
| state | No | Two-letter state code; defaults to MA. Any state other than MA is outside the service area. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| zip | No | ||
| town | No | ||
| error | No | ||
| status | No | ||
| message | No | ||
| success | Yes | ||
| counties | No | ||
| next_step | No | ||
| error_code | No | ||
| matched_by | No | ||
| covered_zips | No | Town lookups only: the town ZIPs inside the automatic-booking area. | |
| outside_zips | No | Town lookups only: the town ZIPs outside the automatic-booking area. | |
| resolved_town | No | Town lookups only: the Massachusetts place the name was matched to. | |
| missing_fields | No | ||
| review_sandbox | No | ||
| in_service_area | No |