Skip to main content
POST
/
api
/
help
/
rma
Open an RMA for a camera
curl --request POST \
  --url https://api2.rhombussystems.com/api/help/rma \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "contactName": "John Doe",
  "contactPhoneNumber": "+1-555-123-4567",
  "deviceName": "Rhombus Camera Pro",
  "problem": "Camera not recording properly",
  "returnShippingAddress": {
    "returnAddressCity": "San Francisco",
    "returnAddressCountry": "United States",
    "returnAddressPostalCode": "94105",
    "returnAddressState": "CA",
    "returnAddressStreet": "123 Main Street"
  },
  "serialNumber": "RHCAM123456789"
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "failureReason": "Invalid serial number",
  "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 processing a Return Merchandise Authorization (RMA).

contactName
string | null

Contact name for the RMA

Example:

"John Doe"

contactPhoneNumber
string | null

Contact phone number for the RMA

Example:

"+1-555-123-4567"

deviceName
string | null

Name of the device for RMA

Example:

"Rhombus Camera Pro"

problem
string | null

Description of the problem with the device

Example:

"Camera not recording properly"

returnShippingAddress
object

Shipping address information for RMA returns.

serialNumber
string | null

Serial number of the device

Example:

"RHCAM123456789"

Response

200 - application/json

OK

Response object for processing a Return Merchandise Authorization (RMA).

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

Reason for failure if RMA processing was unsuccessful

Example:

"Invalid serial number"

success
boolean | null

Whether the RMA processing was successful

Example:

true

ticketId
integer<int32> | null

ID of the RMA ticket created

Example:

12345

warningMsg
string | null