Edit projects

Decommission notice

Purpose

This endpoint enables editing of existing project attributes.

Request data

HTTPS method: PUT

• Constants and parameters enclosed in curly brackets { } must be replaced with their values.
• Please see the following Request parameters section with the required and optional parameters tables for their values. The generic request format is as follows.

URL request format

1
https://{baseURL}/geofencing/{versionNumber}/projects/{projectId}?key={Your_API_Key}&adminKey={Your_Admin_Key}

curl command request format

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

PUT request body

1
{
2
  "name": "a_new_project_name"
3
}

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.
• The order of request parameters is not important.

Note: There are no optional parameters in this endpoint.

Response data

Response body

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

1
{
2
  "name": "new_project_name",
3
  "id": "project_id"
4
}

Response fields

The following data tables describe all of the fields that can appear in a response.

Example

Edit a project

URL request example

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

PUT request body

1
{
2
  "name": "Airports in Bayern"
3
}

Response body example

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