---
title: "Bulk Patch Users"
method: PATCH
path: "/v2/users"
tags: ["API Gateway"]
---

# Bulk Patch Users

`PATCH /v2/users`

Bulk user management API, reserved to super admins.

## Request body

- object
  - `query` union, required
    - object
      - `ids` string[], required
      - `emails` string[]
    - object
      - `ids` string[]
      - `emails` string[], required
  - `behaviour` object
    - `groups` 'replace' | 'add' | 'delete'
  - `data` UserPatch, required
    - `firstName` string
    - `lastName` string
    - `email` string, email
    - `status` 'pending' | 'validated' | 'deactivated'
    - `meta` object
    - `platformRole` string
    - `groups` string[]
    - `groupAcls` object

## Response `200`

Bulk update result

- object
  - `requestedCount` number — Number of users requested to be updated
  - `matchedCount` number — Number of users found and matched
  - `modifiedCount` number — Number of users actually modified

## Other responses

- `401` — Authentication required
- `403` — Bad permissions

---

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