Create a place
curl --request POST \
--url https://api.hellotracks.com/v1/places \
--header 'API-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Ferry Building",
"address": "1 Ferry Building, San Francisco, CA 94111",
"radius": 100,
"location": {
"lat": 37.7955,
"lng": -122.3937
},
"teams": [
1
],
"extendedData": {
"Gate code": "1234"
}
}
'import requests
url = "https://api.hellotracks.com/v1/places"
payload = {
"name": "Ferry Building",
"address": "1 Ferry Building, San Francisco, CA 94111",
"radius": 100,
"location": {
"lat": 37.7955,
"lng": -122.3937
},
"teams": [1],
"extendedData": { "Gate code": "1234" }
}
headers = {
"API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Ferry Building',
address: '1 Ferry Building, San Francisco, CA 94111',
radius: 100,
location: {lat: 37.7955, lng: -122.3937},
teams: [1],
extendedData: {'Gate code': '1234'}
})
};
fetch('https://api.hellotracks.com/v1/places', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hellotracks.com/v1/places",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Ferry Building',
'address' => '1 Ferry Building, San Francisco, CA 94111',
'radius' => 100,
'location' => [
'lat' => 37.7955,
'lng' => -122.3937
],
'teams' => [
1
],
'extendedData' => [
'Gate code' => '1234'
]
]),
CURLOPT_HTTPHEADER => [
"API-Key: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hellotracks.com/v1/places"
payload := strings.NewReader("{\n \"name\": \"Ferry Building\",\n \"address\": \"1 Ferry Building, San Francisco, CA 94111\",\n \"radius\": 100,\n \"location\": {\n \"lat\": 37.7955,\n \"lng\": -122.3937\n },\n \"teams\": [\n 1\n ],\n \"extendedData\": {\n \"Gate code\": \"1234\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hellotracks.com/v1/places")
.header("API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Ferry Building\",\n \"address\": \"1 Ferry Building, San Francisco, CA 94111\",\n \"radius\": 100,\n \"location\": {\n \"lat\": 37.7955,\n \"lng\": -122.3937\n },\n \"teams\": [\n 1\n ],\n \"extendedData\": {\n \"Gate code\": \"1234\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hellotracks.com/v1/places")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Ferry Building\",\n \"address\": \"1 Ferry Building, San Francisco, CA 94111\",\n \"radius\": 100,\n \"location\": {\n \"lat\": 37.7955,\n \"lng\": -122.3937\n },\n \"teams\": [\n 1\n ],\n \"extendedData\": {\n \"Gate code\": \"1234\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"place": {
"id": "p1q2r3",
"type": "place",
"name": "Ferry Building",
"address": "1 Ferry Building",
"email": "frontdesk@example.com",
"phone": "+14155550103",
"city": "San Francisco",
"postalCode": "94111",
"state": "CA",
"countryCode": "US",
"color": "#3366CC",
"radius": 100,
"location": {
"lat": 37.7955,
"lng": -122.3937
},
"teams": [
1,
3
],
"linkedForms": [],
"extendedData": {
"Gate code": "1234",
"Customer no": "C-88"
}
}
},
"error": null,
"meta": {
"path": "/v1/places",
"method": "POST"
}
}{
"data": null,
"error": {
"code": "invalid_request",
"message": "date must be YYYY-MM-DD"
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}{
"data": null,
"error": {
"code": "invalid_api_key",
"message": "Invalid Hellotracks API key."
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}{
"data": null,
"error": {
"code": "forbidden",
"message": "No permission."
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}{
"data": null,
"error": {
"code": "throttled",
"message": "Too many requests."
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}{
"data": null,
"error": {
"code": "internal_error",
"message": "Hellotracks API is temporarily unavailable."
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}Places
Create a place
Creates a place for the company. Workers only when the company allows workersCreatePlaces. Without teams the place goes to the creator’s teams; without a location the address is geocoded in the background. Visits of the last 30 days that match the new place are labeled with it.
POST
/
places
Create a place
curl --request POST \
--url https://api.hellotracks.com/v1/places \
--header 'API-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Ferry Building",
"address": "1 Ferry Building, San Francisco, CA 94111",
"radius": 100,
"location": {
"lat": 37.7955,
"lng": -122.3937
},
"teams": [
1
],
"extendedData": {
"Gate code": "1234"
}
}
'import requests
url = "https://api.hellotracks.com/v1/places"
payload = {
"name": "Ferry Building",
"address": "1 Ferry Building, San Francisco, CA 94111",
"radius": 100,
"location": {
"lat": 37.7955,
"lng": -122.3937
},
"teams": [1],
"extendedData": { "Gate code": "1234" }
}
headers = {
"API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Ferry Building',
address: '1 Ferry Building, San Francisco, CA 94111',
radius: 100,
location: {lat: 37.7955, lng: -122.3937},
teams: [1],
extendedData: {'Gate code': '1234'}
})
};
fetch('https://api.hellotracks.com/v1/places', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hellotracks.com/v1/places",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Ferry Building',
'address' => '1 Ferry Building, San Francisco, CA 94111',
'radius' => 100,
'location' => [
'lat' => 37.7955,
'lng' => -122.3937
],
'teams' => [
1
],
'extendedData' => [
'Gate code' => '1234'
]
]),
CURLOPT_HTTPHEADER => [
"API-Key: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hellotracks.com/v1/places"
payload := strings.NewReader("{\n \"name\": \"Ferry Building\",\n \"address\": \"1 Ferry Building, San Francisco, CA 94111\",\n \"radius\": 100,\n \"location\": {\n \"lat\": 37.7955,\n \"lng\": -122.3937\n },\n \"teams\": [\n 1\n ],\n \"extendedData\": {\n \"Gate code\": \"1234\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hellotracks.com/v1/places")
.header("API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Ferry Building\",\n \"address\": \"1 Ferry Building, San Francisco, CA 94111\",\n \"radius\": 100,\n \"location\": {\n \"lat\": 37.7955,\n \"lng\": -122.3937\n },\n \"teams\": [\n 1\n ],\n \"extendedData\": {\n \"Gate code\": \"1234\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hellotracks.com/v1/places")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Ferry Building\",\n \"address\": \"1 Ferry Building, San Francisco, CA 94111\",\n \"radius\": 100,\n \"location\": {\n \"lat\": 37.7955,\n \"lng\": -122.3937\n },\n \"teams\": [\n 1\n ],\n \"extendedData\": {\n \"Gate code\": \"1234\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"place": {
"id": "p1q2r3",
"type": "place",
"name": "Ferry Building",
"address": "1 Ferry Building",
"email": "frontdesk@example.com",
"phone": "+14155550103",
"city": "San Francisco",
"postalCode": "94111",
"state": "CA",
"countryCode": "US",
"color": "#3366CC",
"radius": 100,
"location": {
"lat": 37.7955,
"lng": -122.3937
},
"teams": [
1,
3
],
"linkedForms": [],
"extendedData": {
"Gate code": "1234",
"Customer no": "C-88"
}
}
},
"error": null,
"meta": {
"path": "/v1/places",
"method": "POST"
}
}{
"data": null,
"error": {
"code": "invalid_request",
"message": "date must be YYYY-MM-DD"
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}{
"data": null,
"error": {
"code": "invalid_api_key",
"message": "Invalid Hellotracks API key."
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}{
"data": null,
"error": {
"code": "forbidden",
"message": "No permission."
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}{
"data": null,
"error": {
"code": "throttled",
"message": "Too many requests."
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}{
"data": null,
"error": {
"code": "internal_error",
"message": "Hellotracks API is temporarily unavailable."
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}Authorizations
Body
application/json
Place fields. Unknown fields are refused with 400. On update only the fields sent change.