Skip to main content
POST
Create a new place to represent customer sites, warehouses, offices, or any fixed location. Places can have check-in radii, custom data fields, and be assigned to specific teams.

REQUEST

string
required
Name of the place. This is the only required field.
object
Location coordinates object with lat and lng properties. If not provided, the system will attempt to geocode based on the address fields.
integer
default:0
Check-in radius in meters. Determines how close a worker needs to be to check in at this location.
string
Street address
string
City name
string
Postal or ZIP code
string
State, province, or region
string
ISO country code (e.g., “US”, “GB”, “DE”)
string
Contact email for this location
string
Contact phone number for this location
string
Color code in hexadecimal format (e.g., “#22c328”)
string
Comma-separated form IDs to link to this place
array
Array of team numbers (integers) that can access this place. If you leave it out and the caller belongs to a company, the place goes to the caller’s teams.
array
Array of custom key-value pair objects for additional data. Each object should have key and val properties.Example: [{"key": "manager", "val": "John Doe"}, {"key": "hours", "val": "9-5"}]

Permissions

  • Company Members: Can create places if they’re not workers, or if workers_create_places setting is enabled
  • Personal Accounts: Can always create places
  • Team Assignment: Without teams, company callers’ places go to the caller’s teams

Automatic Geocoding

If you provide address fields without coordinates, the system will attempt to geocode the location automatically. For best results, provide at least:
  • address + city + country_code, or
  • city + state + country_code

RESPONSE

integer
required
Status code. 0 indicates success.
string
required
Unique identifier of the newly created place. Use this UID to reference the place in other API calls.
object
required
Created place object. See the Place API Object for the complete structure.

Example