Sorry, you need to enable JavaScript to visit this website.

Add new project

 

Product version: 1 (Public Preview)
Last edit: 2019.03.27

On this page

Purpose

This endpoint creates a new project and assigns it to a customer's configuration.

Request data

HTTPS method: POST

URL format

For ease of viewing and identification:

  • Required contants and parameters are shown in bold text.
  • Optional parameters are shown in plain text.
POST https://baseURL/geofencing/versionNumber/projects/project?key=Your_API_Key&adminKey=Your_Admin_Key

curl command

curl -v -XPOST -H "Content-type: application/json" -d '{"name": "a_project_name"}''https://baseURL/geofencing/versionNumber/projects/project?key=Your_API_Key&adminKey=Your_Admin_Key'

POST Request body

{
  "name": "a_project_name"
}

Request parameters

The following table describes the parameters that can be used in a Request.

  • Required parameters must be used or the call will fail.
  • Optional parameters may be used.
  • If there is a default value that will be assumed when an optional parameter is not used, it is shown in the table.
  • The order of request parameters is not important.
Required parameters
Parameter Description
baseURL
string
The base URL for calling the API.
Value: api.tomtom.com
versionNumber
string
Service version number.
Value: 1
key
string
An API Key valid for the requested service.
Value: Your valid API Key.
adminKey
string
An Admin Key valid for the provided API key.
Value: Your valid Admin Key.
Optional parameters
There are no optional parameters in this endpoint.

▲ Return to top

Response data

Response body

The following JSON code block demonstrates a successful Response from the API server.

{
  "name": "a_project_name",
  "id": "a_project_id"
}

Response fields

The following table describes all of the fields that can appear in a Response.

Primary fields
Field Description
name
string
The name of the project.
id
string
The UUID of the project.

HTTP Response codes

Code Meaning and possible causes
201 Created.
400 Bad request: Project name already used.
403 Forbidden:

  • Provided Admin Key is invalid.
  • Admin Key is missing.
  • Number of projects exceeds the limits of current configuration.

Examples

Request format

POST https://api.tomtom.com/geofencing/1/projects/project?key=Your_API_Key&adminKey=Your_Admin_Key

POST Request body

{"name": "Airports in Germany"}

Response body

{
  "name": "Airports in Germany",
  "id": "44de824d-c368-46cf-a234-a6792682dfd6"
}

▲ Return to top

You are here