Help Webservice

Leave feedback of our system

Leave feedback of our system

post/api/help/feedback

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/help/feedback
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

feedbackstring nullable

Feedback message about the system

Example request

{
  "feedback": "The new interface is much more user-friendly!"
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
failureReasonstring nullable

Reason for failure if feedback sending was unsuccessful

successboolean nullable

Whether the feedback was sent successfully

warningMsgstring nullable

Example response

{
  "failureReason": "Invalid feedback content",
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.