Create Place

POST 
https://secure.fleetio.com/api/v1/places

Creates a new Place

Request

application/json

Body

namestringrequired

A name for this Place.

Possible values: <= 255 characters

descriptionstring

A description of this Place.

latitudefloatrequired

This Place's latitude.

Example: 33.515

longitudefloatrequired

This Place's longitude.

Example: -86.80761

radius_in_metersintegerrequired

The radius around this Place's coordinates within which we will consider this Place to have been visited.

Responses

201

OK

Response Headers

application/json

Schema

Schema

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

Example: 2023-03-14T13:46:27-06:00

updated_atdate-time

The date and time at which this record was most recently updated.

Example: 2023-03-14T13:46:27-06:00

account_idId (integer)required

Possible values: >= 1

namestringrequired

A name for this Place.

addressstringnullablerequired

This Place's address.

address_componentsobjectrequired

descriptionstringnullablerequired

A description of this Place.

place_visits_countintegernullablerequired

The number of times this Place has been visited.

radius_in_metersintegerrequired

The radius around this Place's coordinates within which we consider this Place to have been visited.

latitudefloatrequired

This Place's latitude.

Example: 33.515

longitudefloatrequired

This Place's longitude.

Example: -86.80761

is_samplebooleanrequired

Whether this Place is part of Sample Data.

locationstringrequired

The location of this Place.

Example (auto)

{
  "id": 0,
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "account_id": 0,
  "name": "string",
  "address": "string",
  "address_components": {},
  "description": "string",
  "place_visits_count": 0,
  "radius_in_meters": 0,
  "latitude": 33.515,
  "longitude": -86.80761,
  "is_sample": true,
  "location": "string"
}

401

Request could not be authenticated

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

403

Insufficient permission to perform this operation

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

422

Unprocessable Entity

application/json

Schema

Schema

errors object
property name* string[]
Array [
string
]

Example (auto)

{
  "errors": {}
}

Example

{
  "errors": {
    "field1": [
      "error1",
      "error2"
    ],
    "field2": [
      "error3"
    ]
  }
}

500

Something unexpected happened

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).

name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)

• curl
• ruby
• python
• csharp
• go
• java
• nodejs
• php

• CURL

curl -L 'https://secure.fleetio.com/api/v1/places' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>' \
-d '{
  "name": "string",
  "description": "string",
  "latitude": 33.515,
  "longitude": -86.80761,
  "radius_in_meters": 0
}'

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Body

{
  "name": "string",
  "description": "string",
  "latitude": 33.515,
  "longitude": -86.80761,
  "radius_in_meters": 0
}

ResponseClear

Click the Send API Request button above and see the response here!