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

# Update agent settings

> Change an agent's name, icon or workspace.



## OpenAPI

````yaml PATCH /agents/{agentId}
openapi: 3.1.0
info:
  title: Whirl API
  version: 1.0.0
  description: >-
    Read and change Whirl workspaces, tasks, reminders, agents' instructions and
    approvals as the signed-in user. The same operations are available as tools
    on the MCP server at /mcp.
servers:
  - url: https://api.whirl.sh/api/v1
security:
  - oauth2: []
paths:
  /agents/{agentId}:
    patch:
      tags:
        - agents
      summary: Update agent settings
      description: >-
        Change an agent's name, icon or workspace using the same configuration
        permissions as Whirl. Moving requires access to both workspaces.
      operationId: update_agent_settings
      parameters:
        - name: agentId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 64
            description: Agent id from list_agents.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 100
                icon:
                  type: string
                  enum:
                    - brain
                    - bot
                    - sparkles
                    - zap
                    - rocket
                    - wand
                    - lightbulb
                    - star
                    - target
                    - compass
                    - message
                    - mail
                    - inbox
                    - send
                    - phone
                    - headphones
                    - lifebuoy
                    - calendar
                    - clipboard
                    - file
                    - search
                    - chart
                    - briefcase
                    - wrench
                    - bug
                    - shield
                    - cpu
                    - bell
                    - flame
                    - heart
                    - leaf
                    - bird
                    - ghost
                    - user
                    - users
                    - handshake
                    - smile
                    - crown
                    - graduation
                    - stethoscope
                    - chef
                    - hardhat
                    - building
                    - store
                    - globe
                    - pin
                    - home
                    - hotel
                    - landmark
                    - plane
                    - car
                    - truck
                    - package
                    - hammer
                    - palette
                    - camera
                    - mic
                    - code
                    - terminal
                    - database
                    - key
                    - lock
                    - sun
                    - moon
                    - cloud
                    - snowflake
                    - flower
                    - paw
                    - cat
                    - dog
                    - fish
                    - gift
                    - trophy
                    - flag
                    - gem
                    - puzzle
                    - coffee
                    - book
                    - megaphone
                    - scale
                    - piggy
                    - ''
                  description: >-
                    Choose a supported icon name, not an emoji or description.
                    Use an empty string to restore the default icon.
                workspaceId:
                  type: string
              required: []
              additionalProperties: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  agentId:
                    type: string
                  saved:
                    type: boolean
                required:
                  - agentId
                  - saved
                additionalProperties: false
        '400':
          $ref: '#/components/responses/Problem'
        '401':
          $ref: '#/components/responses/Problem'
        '403':
          $ref: '#/components/responses/Problem'
        '404':
          $ref: '#/components/responses/Problem'
        '409':
          $ref: '#/components/responses/Problem'
        '422':
          $ref: '#/components/responses/Problem'
        '429':
          $ref: '#/components/responses/Problem'
      security:
        - oauth2:
            - agents:write
components:
  responses:
    Problem:
      description: RFC 9457 problem details
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  schemas:
    Problem:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        code:
          type: string
      required:
        - title
        - status
        - code
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://api.whirl.sh/oauth/authorize
          tokenUrl: https://api.whirl.sh/oauth/token
          refreshUrl: https://api.whirl.sh/oauth/token
          scopes:
            workspace:read: >-
              Workspaces, tasks, People, task context, notes, messages,
              reminders, and pending approvals.
            workspace:write: >-
              Create and update tasks, People, task context, notes, tags,
              reminders, and workspaces.
            agents:read: >-
              Agents, runs, configuration, handbook, memory, tone examples,
              scheduled tasks, and connected-service research.
            agents:write: >-
              Edit agent configuration, handbook, memory, tone examples, and
              schedules, and give agents tasks.
            approvals:write: Approve, reject, or edit actions agents want to take.
            offline_access: >-
              Keep access without asking you to sign in again, until you
              disconnect it.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.