Skip to main content
POST
/
api
/
createplace
curl -X POST https://api.hellotracks.com/api/createplace \
  --header 'API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  -d '{
    "data": {
      "name": "Downtown Office",
      "address": "123 Main Street",
      "city": "San Francisco",
      "state": "CA",
      "postalcode": "94105",
      "country_code": "US",
      "radius": 100,
      "phone": "+14155551234",
      "email": "office@company.com",
      "extended_data": [
        {"key": "floor", "val": "5"},
        {"key": "suite", "val": "500"}
      ]
    }
  }'

{
  "status": 123,
  "uid": "<string>",
  "place": {}
}
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

POST https://api.hellotracks.com/api/createplace

{
   "data": {
      "name": "Station 101",
      "radius": 200,
      "address": "Laguna Street 123",
      "city": "San Francisco",
      "postalcode": "94123",
      "state": "CA",
      "country_code": "US",
      "email": "station@email.com",
      "phone": "+14151234567",
      "color": "#22c328",
      "location": {
        "lat": 37.7578149,
        "lng": -122.5078122
      },
      "linkedForms": "",
      "teams": [1, 2],
      "extended_data": [
        {"key": "manager", "val": "John Doe"},
        {"key": "capacity", "val": "50"}
      ]
   }
}
​
name
string
required
Name of the place. This is the only required field.
​
location
object
Location coordinates object with lat and lng properties. If not provided, the system will attempt to geocode based on the address fields.
​
radius
integer
default:0
Check-in radius in meters. Determines how close a worker needs to be to check in at this location.
​
address
string
Street address
​
city
string
City name
​
postalcode
string
Postal or ZIP code
​
state
string
State, province, or region
​
country_code
string
ISO country code (e.g., “US”, “GB”, “DE”)
​
email
string
Contact email for this location
​
phone
string
Contact phone number for this location
​
color
string
Color code in hexadecimal format (e.g., “#22c328”)
​
linkedForms
string
Comma-separated form IDs to link to this place
​
teams
array
Array of team numbers (integers) that can access this place. When the caller belongs to a company, Hellotracks assigns the created place to the caller’s current teams after processing request fields. Use /api/editplace after creation if you need to set explicit teams.
​
extended_data
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: For company callers, the place will automatically be assigned to the caller’s teams after creation

​
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

{
  "status": 0,
  "uid": "<uid-of-created-place>",
  "place": {
    "uid": "<uid-of-created-place>",
    "name": "Station 101",
    "creator": "Acme Dispatch",
    "data": []
  }
}
​
status
integer
required
Status code. 0 indicates success.
​
uid
string
required
Unique identifier of the newly created place. Use this UID to reference the place in other API calls.
​
place
object
required
Created place object. See the Place API Object for the complete structure.

​
Example

curl -X POST https://api.hellotracks.com/api/createplace \
  --header 'API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  -d '{
    "data": {
      "name": "Downtown Office",
      "address": "123 Main Street",
      "city": "San Francisco",
      "state": "CA",
      "postalcode": "94105",
      "country_code": "US",
      "radius": 100,
      "phone": "+14155551234",
      "email": "office@company.com",
      "extended_data": [
        {"key": "floor", "val": "5"},
        {"key": "suite", "val": "500"}
      ]
    }
  }'