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

# Update API key

> Updates an API key's name, description, scopes, or expiration.



## OpenAPI

````yaml api-reference/v1/openapi.yaml patch /v1/admin/api-keys/{id}
openapi: 3.1.0
info:
  title: Goods API
  version: 1.0.0
  description: >-
    API for Goods grocery operations - scanner app, admin dashboard, and
    customer features
  contact:
    name: Goods Team
    url: https://goods.app
servers:
  - url: http://localhost:3000
    description: Local development
  - url: https://dev.api.switchyard.run
    description: Development
  - url: https://api.switchyard.run
    description: Production
security: []
tags:
  - name: v1
    description: API v1 - unified domain-based endpoints
  - name: Scanner
    description: Scanner app endpoints for drivers and pickers
  - name: Sweeps
    description: Sweep management - retail store pickup operations
  - name: RFC Picks
    description: Ready-for-checkout picking operations
  - name: Inventory
    description: Inventory management and barcode lookup
  - name: Admin
    description: Admin dashboard endpoints
  - name: Orders
    description: Order management
  - name: Products
    description: Product catalog management
  - name: Notifications
    description: Push, email, SMS, and Slack notification management
paths:
  /v1/admin/api-keys/{id}:
    patch:
      tags:
        - API Keys
      summary: Update API key
      description: Updates an API key's name, description, scopes, or expiration.
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: id
          in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 100
                description:
                  type: string
                  maxLength: 500
                scopes:
                  type: array
                  items:
                    type: string
                expires_at:
                  type: string
                  nullable: true
                  format: date-time
                is_active:
                  type: boolean
      responses:
        '200':
          description: Updated API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  api_key:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      name:
                        type: string
                      key_prefix:
                        type: string
                      key_last_four:
                        type: string
                      staff_id:
                        type: string
                        format: uuid
                      description:
                        type: string
                        nullable: true
                      scopes:
                        type: array
                        items:
                          type: string
                      is_active:
                        type: boolean
                      expires_at:
                        type: string
                        nullable: true
                      last_used_at:
                        type: string
                        nullable: true
                      usage_count:
                        type: number
                      created_at:
                        type: string
                      updated_at:
                        type: string
                      revoked_at:
                        type: string
                        nullable: true
                      staff:
                        type: object
                        nullable: true
                        properties:
                          id:
                            type: string
                            format: uuid
                          email:
                            type: string
                          first_name:
                            type: string
                            nullable: true
                          last_name:
                            type: string
                            nullable: true
                        required:
                          - id
                          - email
                          - first_name
                          - last_name
                    required:
                      - id
                      - name
                      - key_prefix
                      - key_last_four
                      - staff_id
                      - description
                      - scopes
                      - is_active
                      - expires_at
                      - last_used_at
                      - usage_count
                      - created_at
                      - updated_at
                      - revoked_at
                      - staff
                required:
                  - success
                  - api_key

````