Skip to main content

Add Area

POST 
/area/add

Creates a new area and returns the saved object. An area defines a geographic territory using polygon coordinates and optional filter criteria. The server automatically cleans invalid polygon geometries (e.g., self-intersections) before saving.

Coordinates are an array of {latitude, longitude} objects forming an open polygon — do not repeat the first point at the end.

Assignment types:

  • user — assigned to specific user(s)
  • team — assigned to a team
  • draft — not yet assigned

Filters narrow which accounts within the polygon are eligible for assignment (by state, city, zip code, status, workflow stage, team, user, or custom fields).

Schedule entries allow timed assign, unassign, or reassign actions.

Requires the area:add permission scoped to the area's team or users.

Request​

Responses​

Success