Send feedback about a map - Fluid Topics - Latest

Fluid Topics API Reference Guide
Category
Reference Guides
Audience
public
Version
Latest

This web service makes it possible to send feedback about a map.

Method Endpoint
POST 
/api/khub/maps/{mapId}/feedback
Path parameter Type Description
{mapId} String Expects the id associated with the map. Users can get the id by listing maps or searching maps.
  • This web service requires the caller to be authenticated and have the FEEDBACK_USER role.
  • It is necessary to provide an Ft-Calling-App value when using Fluid Topics web services. See Fluid Topics calling app.

This web service requires authentication on portals with mandatory authentication.

Request example

The following lines show an example of a JSON request body:

{
  "message": "This is my feedback message",
  "from": "jdoe@example.com"
}
Field Type Required? Description
message String Yes A message containing the caller's feedback.
from String Yes The email address of the feedback's sender. It is only necessary when the Email service for unauthenticated users setting is set to Feedback sent by Fluid Topics email sending method.
Return code Description
200 OK The feedback was submitted.
401 UNAUTHORIZED The authorization header is absent or invalid.
403 FORBIDDEN The user or API key does not have the FEEDBACK_USER role.
404 NOT FOUND No map exists with this identifier.

For a comprehensive list of all possible return codes, see Return codes.