POST Create a new location

Create a new location

Endpoint

POST https://api.timekit.io/v2/locations

Parameters

Name	In	Type	Required	Description
`name`	body	string	yes	name of the location
`description`	body	string	yes	description of the current location
`latitude`	body	float	yes	latitude of the location
`longitude`	body	float	yes	longitude of the location
`projects`	body	array_string		list of project uuids that you want to attach to this location
`meta`	body	array_object		metadata that you want to attach to this location

Request examples

curlcurl --request POST \
  --url https://api.timekit.io/v2/locations?include=projects \
  --header 'Content-Type: application/json' \
  --user :test_api_key_nvHfRSlhvsnlg4rS7Wt28Ty47qdgegwSu3YK7hPW \
  --data '{
    "name": "Toronto",
    "description": "Whatever works best for you!!",
    "latitude": 42.50798000,
    "longitude": 1.52480000,
    "projects": ["1e1ea71e-5908-45d0-8099-bf7afadc59dd"],
    "meta": {
        "city": "Toronto"
    }
 }'

Response examples

201

latitude, longitude and distance are numbers. meta always contains the standard t_store_*, t_latitude and t_longitude keys alongside your own. With ?include=projects, each entry in projects is a full project object, the same shape as in List all projects; it is shortened below.

json{
    "data": {
        "meta": {
            "t_store_id": "",
            "t_latitude": "42.50798000",
            "t_longitude": "1.52480000",
            "t_store_city": "",
            "t_store_code": "",
            "t_store_name": "",
            "t_store_phone": "",
            "t_store_region": "",
            "t_store_address": "",
            "t_store_country": "",
            "t_store_timezone": "",
            "t_store_capacity": "",
            "t_store_disabled": "",
            "t_store_postal_code": "",
            "t_store_region_name": "",
            "t_store_country_name": "",
            "city": "Toronto"
        },
        "id": "f388cc28-e250-40eb-b39f-6c91b66918b0",
        "name": "Toronto",
        "description": "Whatever works best for you!!",
        "latitude": 42.50798,
        "longitude": 1.5248,
        "use_custom_hours": null,
        "availability_constraints": [],
        "created_at": "2021-08-13T14:39:16+0000",
        "updated_at": "2021-08-13T14:39:16+0000",
        "distance": 0,
        "projects": [
            {
                "id": "1e1ea71e-5908-45d0-8099-bf7afadc59dd",
                "name": "Square One-Fitting",
                "slug": "square-one-fitting",
                "availability": {
                    "mode": "roundrobin_random"
                },
                "booking": {
                    "graph": "instant",
                    "what": "Fitting",
                    "where": "Square One",
                    "rescheduling_url": "https://book.timekit.io/square-one-fitting"
                },
                "meta": {},
                "created_at": "2021-08-13T14:30:02+0000",
                "updated_at": "2021-08-13T14:30:02+0000"
            }
        ]
    }
}

422

json{
  "errors": {
    "name": [
      "The name field is required."
    ],
    "description": [
      "The description field is required."
    ],
    "latitude": [
      "The latitude field is required."
    ],
    "longitude": [
      "The longitude field is required."
    ]
  }
}