> ## 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.

# Update keypad

> Update keypad settings



## OpenAPI

````yaml https://api2.rhombussystems.com/api/openapi/public.json post /api/keypad/updateKeypad
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/keypad/updateKeypad:
    post:
      tags:
        - Alarm Monitoring Keypad Webservice
      summary: Update keypad
      description: Update keypad settings
      operationId: updateKeypad
      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/Keypad_UpdateKeypadRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Keypad_UpdateKeypadResponse'
          description: OK
components:
  schemas:
    Keypad_UpdateKeypadRequest:
      type: object
      description: Request object for updating keypad settings and configuration.
      properties:
        additionalFeaturesDisabled:
          type: boolean
          nullable: true
        armCountdownSecs:
          type: integer
          format: int32
          description: Arm countdown seconds for the keypad
          example: 30
          nullable: true
        buildingAdminPhoneNumber:
          type: string
          description: Phone number of the building administrator
          example: +1-555-123-4567
          nullable: true
        floorNumber:
          type: integer
          format: int32
          description: Floor number where the keypad is located
          example: 1
          nullable: true
        keypadUuid:
          type: string
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
        latitude:
          type: number
          format: double
          description: Latitude coordinate of the keypad location
          example: 37.7749
          nullable: true
        locationName:
          type: string
          description: Name of the location where the keypad is installed
          example: Main Building
          nullable: true
        locationUuid:
          type: string
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
        logoUuid:
          type: string
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
        longitude:
          type: number
          format: double
          description: Longitude coordinate of the keypad location
          example: -122.4194
          nullable: true
        name:
          type: string
          description: Name of the keypad
          example: Main Entrance Keypad
          nullable: true
        qualifiedAddress:
          $ref: '#/components/schemas/QualifiedAddressType'
        showCallBuildingAdmin:
          type: boolean
          description: Whether to show the call building admin option
          example: true
          nullable: true
        subLocationsHierarchyKey:
          type: string
          format: SubLocationsHierarchyKey
          description: |
            A sequence of one or more base 64 (url-safe) uuid substrings.
            These substrings are separated by dots (.).
          example: AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
          pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$
        subLocationsHierarchyKeyUpdated:
          type: boolean
          description: Whether the sub-locations hierarchy key has been updated
          example: false
          nullable: true
        timeZoneId:
          type: string
          description: Time zone ID for the keypad location
          example: America/Los_Angeles
          nullable: true
        videoWallUuid:
          type: string
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
        videoWallUuidUpdated:
          type: boolean
          description: Whether the video wall UUID has been updated
          example: false
          nullable: true
    Keypad_UpdateKeypadResponse:
      type: object
      description: Response object for updating keypad settings.
      properties:
        error:
          type: boolean
          nullable: true
        errorMsg:
          type: string
          nullable: true
        warningMsg:
          type: string
          nullable: true
    QualifiedAddressType:
      type: object
      description: Qualified address information for the keypad location
      properties:
        addressLine2:
          type: string
          description: apt, suite, or unit
          nullable: true
        addressline1:
          type: string
          description: street address
          nullable: true
        administrativeArea:
          type: string
          description: state
          nullable: true
        locality:
          type: string
          description: city
          nullable: true
        postalCode:
          type: string
          description: zip code
          nullable: true
        regionCode:
          type: string
          description: country
          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

````