Skip to main content
POST
/
api
/
help
/
ticket
Open a support ticket
curl --request POST \
  --url https://api2.rhombussystems.com/api/help/ticket \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "body": "My camera is not connecting to the network properly.",
  "collaborators": [
    "<string>"
  ],
  "consoleAccessGranted": true,
  "productType": "<string>",
  "serialNumbers": [
    "<string>"
  ],
  "serviceType": "<string>",
  "subject": "Camera connectivity issue"
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "failureReason": "Invalid email address",
  "success": true,
  "ticketId": 12345,
  "warningMsg": "<string>"
}

Authorizations

​
x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

​
x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for creating a support ticket.

​
body
string | null

Body content of the support ticket

Example:

"My camera is not connecting to the network properly."

​
collaborators
(string | null)[] | null

List of collaborator email addresses

List of collaborator email addresses

​
consoleAccessGranted
boolean | null

Whether console access has been granted for troubleshooting

Example:

true

​
productType
string | null
​
serialNumbers
(string | null)[] | null

List of device serial numbers related to the issue

List of device serial numbers related to the issue

​
serviceType
string | null
​
subject
string | null

Subject of the support ticket

Example:

"Camera connectivity issue"

Response

200 - application/json

OK

Response object for creating a support ticket.

​
error
boolean | null
​
errorMsg
string | null
​
failureReason
string | null

Reason for failure if ticket creation was unsuccessful

Example:

"Invalid email address"

​
success
boolean | null

Whether the ticket creation was successful

Example:

true

​
ticketId
integer<int32> | null

ID of the created support ticket

Example:

12345

​
warningMsg
string | null