Skip to main content
POST
/
v1
/
sites
Create a new Site
curl --request POST \
  --url https://api.tread-horizon.com/v1/sites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "lat": "<string>",
  "lon": "<string>",
  "notes": "<string>",
  "site_type": "Plant",
  "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "next_billion_geofence": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "moving_geofence": false
  },
  "external_id": "<string>",
  "full_address": "<string>",
  "department_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contacts": [
    {
      "name": "<string>",
      "email": "<string>",
      "phone": "+18885551234"
    }
  ]
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "company": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tread_id": "ABC123",
      "legal_name": "<string>",
      "company_type": "hauler"
    },
    "name": "<string>",
    "lat": "<string>",
    "lon": "<string>",
    "notes": "<string>",
    "state": "active",
    "external_id": "<string>",
    "full_address": "<string>",
    "routable": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "discarded_at": "2023-11-07T05:31:56Z",
    "address": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "thoroughfare": "<string>",
      "premise": "<string>",
      "locality": "<string>",
      "administrative_area": "<string>",
      "postal_code": "<string>",
      "country": "US",
      "lat": "<string>",
      "lon": "<string>",
      "place_id": "<string>"
    },
    "site_type": "Plant",
    "next_billion_geofence": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "geofence": {
        "name": "<string>",
        "type": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "geojson": {
          "type": "<string>",
          "coordinates": [
            [
              [
                "<unknown>"
              ]
            ]
          ]
        },
        "circle_center": {
          "lat": 123,
          "lon": 123
        },
        "circle_radius": 123
      },
      "moving_geofence": false
    },
    "moving_site": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "equipment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "polling_interval_seconds": 123
    },
    "department": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "contacts": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "email": "<string>",
        "phone": "+18885551234"
      }
    ],
    "editable": true,
    "company_share": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "<string>",
      "ticket_match_id": "<string>",
      "sender_company": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "tread_id": "ABC123",
        "legal_name": "<string>",
        "company_type": "hauler"
      },
      "dispatchable": true,
      "schedule_on": true,
      "rate_override": true,
      "expires_at": "2023-11-07T05:31:56Z"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Accept-Language
string
default:en

The Accept-Language request HTTP header indicates the natural language and locale that the client prefers.

Example:

"en"

Body

application/json
​
name
string
required
​
lat
string | null
required

Latitude of the site. If not provided, the latitude from the address will be used.

​
lon
string | null
required

Longitude of the site. If not provided, the longitude from the address will be used.

​
address
Address-Create · object
​
notes
string
​
site_type
enum<string>
Available options:
Plant,
Quarry,
JobSite,
Depot,
Other,
Daily,
EquipmentHomeBase
Example:

"Plant"

​
company_id
string<uuid>
​
next_billion_geofence
Geofence-Data · object
​
external_id
string | null
​
full_address
string
​
moving_site
MovingSite-Create · object
​
department_id
string<uuid> | null
​
contacts
Contact-Create · object[]

Response

Created

​
data
Site-Read · object
required