> ## 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 portal status

> Activate or deactivate a pickup portal. Used by the robot dashboard to manage portal availability.



## OpenAPI

````yaml api-reference/v1/openapi.yaml patch /v1/portals/{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/portals/{id}:
    patch:
      tags:
        - Portals
      summary: Update portal status
      description: >-
        Activate or deactivate a pickup portal. Used by the robot dashboard to
        manage portal availability.
      parameters:
        - schema:
            type: string
            description: Portal ID
          required: true
          name: id
          in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                is_active:
                  type: boolean
                  description: Whether the portal is active
              required:
                - is_active
      responses:
        '200':
          description: Portal updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  portal:
                    type: object
                    properties:
                      id:
                        type: string
                      portal_number:
                        type: number
                      name:
                        type: string
                      is_active:
                        type: boolean
                        nullable: true
                    required:
                      - id
                      - portal_number
                      - name
                      - is_active
                required:
                  - portal
        '404':
          description: Portal not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error message
                    example: Not found
                required:
                  - error
        '500':
          description: Server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error message
                    example: Not found
                required:
                  - error

````