---
title: "Patch end users"
method: PATCH
path: "/beta/endusers"
tags: ["End Users"]
---

# Patch end users

`PATCH /beta/endusers`

Bulk patch end users.

## Request body

- BulkPatchEndUsersInput
  - `data` BulkPatchEndUserInput[]
    - `id` string, uuid, required
    - `displayName` string
    - `email` string
    - `phoneNumber` string
    - `additionalEmails` string[]
    - `additionalPhoneNumbers` string[]
    - `firstName` string
    - `lastName` string
    - `middleNames` string[]
    - `avatarUrl` string
    - `externalId` string

## Response `200`

The patched end users

- BulkPatchEndUsersOutput
  - `data` BulkActionOutcomeBulkErrorEndUser[]
    - union
      - BulkActionFailureBulkErrorEndUser
        - `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
      - BulkActionSuccessBulkErrorEndUser
        - `data` EndUser, required
          - `id` string, uuid, required — Unique identifier for the contact
          - `createdAt` string, date-time, required — Time when the contact was created
          - `displayName` string — The contact's display name
          - `email` string — The contact's primary email address
          - `phoneNumber` string — The contact's primary phone number
          - `additionalEmails` string[] — Additional email addresses for the contact
          - `additionalPhoneNumbers` string[] — Additional phone numbers for the contact
          - `firstName` string — The contact's first name
          - `lastName` string — The contact's last name
          - `middleNames` string[] — The contact's middle names
          - `avatarUrl` string — The url from which to load the contact's avatar
          - `externalId` string — Custom external identifier for the contact
          - `customAttributes` CustomAttribute[] — Custom attributes for the contact
            - `id` string, uuid, required
            - `name` string, required
            - `identifier` string, required
            - `value` union, required — AttributeValue values: String[] if the type of the custom attribute is Select or String if the type of the custom attribute is Text
              - …

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