---
title: "Patch agents"
method: PATCH
path: "/beta/agents"
tags: ["Agents"]
---

# Patch agents

`PATCH /beta/agents`

Bulk patch agents/admins.

## Request body

- BulkPatchAgentInput[]
  - `id` string, required — Unique identifier for the agent
  - `displayName` string — The agent's display name
  - `phoneNumber` string — The agent's primary phone number
  - `additionalEmails` string[] — Additional email addresses for the agent
  - `additionalPhoneNumbers` string[] — Additional phone numbers for the agent
  - `firstName` string — The agent's first name
  - `lastName` string — The agent's last name
  - `middleNames` string[] — The agent's middle names
  - `avatarUrl` string — The url from which to load the agent's avatar

## Response `200`

The list of patch action outcomes

- BulkUpdateAgentOutput
  - `data` BulkActionOutcomeBulkErrorAgent[]
    - union
      - BulkActionFailureBulkErrorAgent
        - `error` union, required
          - EmptyPatchSet
            - `id` string, required
            - `message` string, required
          - ErrorResponse
            - `message` string, required
          - Infrastructure
            - `id` string, required
            - `message` string, required
          - Integrity
            - `id` string, required
            - `message` string, required
          - InvalidArgument
            - `message` string, required
          - NotFound1
            - `id` string, required
            - `message` string, required
          - Validation
            - `id` string
            - `message` string, required
      - BulkActionSuccessBulkErrorAgent
        - `data` Agent, required
          - `id` string, uuid, required — Unique identifier for the agent
          - `createdAt` string, date-time, required — Time when the agent was created
          - `displayName` string, required — The agent's display name
          - `email` string, required — The agent's primary email address
          - `avatarUrl` string — The url from which to load the agent's avatar
          - `phoneNumber` string — The agent's primary phone number
          - `additionalEmails` string[] — Additional email addresses for the agent
          - `additionalPhoneNumbers` string[] — Additional phone numbers for the agent
          - `firstName` string — The agent's first name
          - `lastName` string — The agent's last name
          - `middleNames` string[] — The agent's middle names
          - `roles` string[] — The agent's roles

## Other responses

- `400` — Invalid value extracted from request context, Invalid value for: body
- `500` — Internal failure during request processing

---

[API](https://skmtc.net/dixa/apis/dixa-api.md) · [All operations](https://skmtc.net/dixa/apis/dixa-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/dixa/dixa-api/versions/041e058483f0/schema)