Sorry, you need to enable JavaScript to visit this website.
Geofencing API
Get your key

Edit projects

 

Service version: 1
Last edit: 2019.09.18

On this page

Purpose

This endpoint enables editing of existing project attributes.

Request data

HTTPS method: PUT

URL format

For ease of viewing and identification:

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

curl command

curl -XPUT "Content-type: application/json" -d '{"name": "a_new_project_name"}''https://baseURL/geofencing/versionNumber/projects/projectId?key=Your_API_Key&adminKey=Your_Admin_Key'

PUT request body

{
  "name": "a_new_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
projectId
string 		The unique ID of a project to edit.
Value: UUID.
key
string 		An API Key valid for the requested service.
Value: Your valid API Key.
adminKey
string 		An Admin Key valid for the requested service.
Value: Your valid Admin Key.
Optional parameters
This endpoint does not have any optional parameters.

▲ Return to top

Response data

Response body

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

{
  "name": "new_project_name",
  "id": "project_id"
}

Response fields

The following data tables describe 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.

HTTPS response codes

Code Meaning and possible causes
200 OK
403 Forbidden:
  • Provided Admin Key is invalid.
  • Admin Key is missing.
404 Not Found: Project with the specified id does not exist.

Examples

Request format

https://api.tomtom.com/geofencing/1/projects/44de824d-c368-46cf-a234-a6792682dfd6?key=Your_API_Key?adminKey=Your_Admin_Key

PUT request body

{
  "name": "Airports in Bayern"
}

Response body

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

▲ Return to top