> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.rhombus.community/llms.txt
> Use this file to discover all available pages before exploring further.

# Open an RMA for a camera

> Open an RMA for a camera



## OpenAPI

````yaml https://api2.rhombussystems.com/api/openapi/public.json post /api/help/rma
openapi: 3.0.1
info:
  contact:
    email: developer@rhombussystems.com
  description: >-
    This API is for use by Rhombus customers and partners.


    ## Authentication


    All requests require two headers:

    - `x-auth-scheme` — The authentication scheme identifier. Use `api-token`
    for standard API key auth, or `partner-api-token` for partner API auth.

    - `x-auth-apikey` — Your Rhombus API key.


    Example:

    ```

    POST /api/camera/getMinimalCameraStateList

    x-auth-scheme: api-token

    x-auth-apikey: YOUR_API_KEY

    Content-Type: application/json

    ```
  title: Rhombus API
  version: '1.0'
servers:
  - description: Production Server
    url: https://api2.rhombussystems.com
security:
  - ApiKeyAuth: []
paths:
  /api/help/rma:
    post:
      tags:
        - Help Webservice
      summary: Open an RMA for a camera
      description: Open an RMA for a camera
      operationId: processRMA
      parameters:
        - description: >-
            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.
          example: api-token
          in: header
          name: x-auth-scheme
          required: true
          schema:
            type: string
            default: api-token
            enum:
              - api-token
              - api
              - partner-api-token
              - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Help_ProcessRMAWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Help_ProcessRMAWSResponse'
          description: OK
components:
  schemas:
    Help_ProcessRMAWSRequest:
      type: object
      description: Request object for processing a Return Merchandise Authorization (RMA).
      properties:
        contactName:
          type: string
          description: Contact name for the RMA
          example: John Doe
          nullable: true
        contactPhoneNumber:
          type: string
          description: Contact phone number for the RMA
          example: +1-555-123-4567
          nullable: true
        deviceName:
          type: string
          description: Name of the device for RMA
          example: Rhombus Camera Pro
          nullable: true
        problem:
          type: string
          description: Description of the problem with the device
          example: Camera not recording properly
          nullable: true
        returnShippingAddress:
          $ref: '#/components/schemas/Help_ShippingAddress'
        serialNumber:
          type: string
          description: Serial number of the device
          example: RHCAM123456789
          nullable: true
    Help_ProcessRMAWSResponse:
      type: object
      description: Response object for processing a Return Merchandise Authorization (RMA).
      properties:
        error:
          type: boolean
          nullable: true
        errorMsg:
          type: string
          nullable: true
        failureReason:
          type: string
          description: Reason for failure if RMA processing was unsuccessful
          example: Invalid serial number
          nullable: true
        success:
          type: boolean
          description: Whether the RMA processing was successful
          example: true
          nullable: true
        ticketId:
          type: integer
          format: int32
          description: ID of the RMA ticket created
          example: 12345
          nullable: true
        warningMsg:
          type: string
          nullable: true
    Help_ShippingAddress:
      type: object
      description: Shipping address information for RMA returns.
      properties:
        returnAddressCity:
          type: string
          description: City for return shipping
          example: San Francisco
          nullable: true
        returnAddressCountry:
          type: string
          description: Country for return shipping
          example: United States
          nullable: true
        returnAddressPostalCode:
          type: string
          description: Postal code for return shipping
          example: '94105'
          nullable: true
        returnAddressState:
          type: string
          description: State/province for return shipping
          example: CA
          nullable: true
        returnAddressStreet:
          type: string
          description: Street address for return shipping
          example: 123 Main Street
          nullable: true
  securitySchemes:
    ApiKeyAuth:
      description: >-
        Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header
        set to `api-token` (or `partner-api-token` for partner endpoints).
      in: header
      name: x-auth-apikey
      type: apiKey

````