Help Webservice

Open a support ticket with file upload

Open a support ticket and optionally include a file upload. Uploading multiple Files are not supported throught this call.

post/api/help/ticketWithFile

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/help/ticketWithFile
  • 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.

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 ticket creation was unsuccessful

successboolean nullable

Whether the ticket creation was successful

ticketIdinteger nullable

ID of the created support ticket

warningMsgstring nullable

Example response

{
  "failureReason": "Invalid email address",
  "success": true,
  "ticketId": 12345
}

Changes

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