REQUEST
Name of the place. This is the only required field.
Location coordinates object with
lat and lng properties. If not provided, the system will attempt to geocode based on the address fields.Check-in radius in meters. Determines how close a worker needs to be to check in at this location.
Street address
City name
Postal or ZIP code
State, province, or region
ISO country code (e.g., “US”, “GB”, “DE”)
Contact email for this location
Contact phone number for this location
Color code in hexadecimal format (e.g., “#22c328”)
Comma-separated form IDs to link to this place
Array of team numbers (integers) that can access this place. If not specified and you’re part of a company, your teams will be automatically assigned.
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"}]Visibility setting. Use “network” to share with your network (personal accounts only).
Permissions
- Company Members: Can create places if they’re not workers, or if
workers_create_placessetting is enabled - Personal Accounts: Can always create places
- Team Assignment: For company members, the place will automatically be assigned to your 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
Status code.
0 indicates success.Unique identifier of the newly created place. Use this UID to reference the place in other API calls.