Skip to main content

Run Area Assignment

POST 
/area/assign

Triggers an assignment run for one or more areas. This is an asynchronous operation — it returns immediately with a success response while the assignment processes in the background.

Run types:

  • assign — assigns accounts within each area's polygon and filters to the area's configured team/user
  • unassign — removes team/user assignments from accounts in the area and sets the area to draft
  • reassign — re-runs assignment, potentially changing account ownership

If an overlapping area is already running an assignment, the request will be rejected with an error identifying the conflicting area.

Use /area/get to check the jobInfo field for assignment progress (preparing, queued, running, completed).

Requires the area:add permission.

Request​

Responses​

Success