Developer

Create feedback

Request Access
Service version: 1.0.0
Last edit: 2025.09.26

Important note
This API is not available as part of our free evaluation or Pay As You Grow (PAYG) offering. Click the Request Access button above to contact our Sales team.

Purpose

This call is used to create a feedback. Like all other methods of this API, this method requires a TomTom API key. This information will be used to identify the creator of the feedback.

How to request data

HTTP method: POST

  • 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 these values. The generic URL format is as follows.

URL request format

post
URL request format
https://{baseURL}/maps/orbis/feedback?key={API-key}&apiVersion={version}

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.

Parameter

Required

Type

Description

geometry

Yes

string

Center location for the feedback in well-known text (WKT) format. Coordinates must be in longitude-latitude (lon lat) order, e.g. POINT(-3.693252 40.399412).

kind

Yes

string

The schema name used in the data field. This schema must be defined and agreed upon with the TomTom team.

data

Yes

string

Feedback body, a base64 JSON-encoded string following the schema of type ‘kind’

severity

Yes

integer

Severity of the feedback. Must be greater than 0. A lower value means higher severity

labels

No

list of strings

Labels attached to the feedback. A maximum of 20 labels is allowed.

referenceId

No

string

Reference ID of the feedback provided by the customer. The value is unique in the context of the customer.

Example request

1{
2 "geometry": "POINT(19.4560 51.7592)",
3 "kind": "Example_Kind",
4 "data": "ewogICJ0aXRsZSI6ICJQcm9ibGVtIG9uIE1hcCIsCiAgImNyZWF0ZWREYXRlIjogIjIwMjUtMDYtMDYiLAogICJ1c2VyQ29tbWVudCI6ICJUaGlzIHJvYWQgc2hvdWxkIGJlIGRlbGV0ZWQuIiwKICAibG9jYXRpb24iOiAiUE9JTlQoMTkuNDU2MCA1MS43NTkyKSIsCn0=",
5 "severity": 1,
6 "labels": [
7   "Label1"
8 ],
9 "referenceId": "123001"
10}

Response data

Response codes

HTTP Code

Message

Description

Sample response

201

Created

Feedback created successfully

1{
2  "feedbackId": "7049aa04-91bd-4ad3-8085-bd8bec318905"
3}

400

Bad Request

Invalid request parameters

1{
2  "errorText": "Validation failed",
3  "detailedError": {
4    "code": "BAD_REQUEST",
5    "message": "kind: must not be blank"
6  },
7  "httpStatusCode": 400
8}

403

Forbidden

Access denied

1{
2  "detailedError": {
3    "code": "Forbidden",
4    "message": "You are not allowed to access this endpoint"
5  }
6}

409

Conflict

Conflicting id

1{
2  "errorText": "Feedback with reference id=mfa-demo-ts-4352167842 already exists",
3  "detailedError": {
4    "code": "CONFLICT",
5    "message": "Feedback with reference id=mfa-demo-ts-4352167842 already exists"
6  },
7  "httpStatusCode": 409
8}

500

Internal Server Error

Internal server error

1{
2  "errorText": "An unexpected error has occurred. Please try again later.",
3  "detailedError": {
4    "code": "INTERNAL_SERVER_ERROR",
5    "message": "An unexpected error has occurred. Please try again later."
6  },
7  "httpStatusCode": 500
8}