---
title: "Update Users"
method: POST
path: "/users/update"
tags: ["Users"]
---

# Update Users

`POST /users/update`

## Request

- Base URL: `https://api.velt.dev/v2`
- URL: `https://api.velt.dev/v2/users/update`
- Auth: API key in header `x-velt-api-key` and API key in header `x-velt-auth-token`

Use this API to update user metadata based on various filters such as organization ID, document ID, folder ID and user IDs.

**Access Control:**
Set `accessRole` to `viewer` (read-only) or `editor` (read/write) for each resource.

## Request body

- object
  - `data` object, required
    - `organizationId` string, required: Organization ID
    - `documentId` string: Document ID
    - `folderId` string: Folder ID
    - `users` User[], required
      - `userId` string, required: Unique identifier for the user
      - `name` string, required: Display name of the user
      - `email` string, email, required: Email address of the user
      - `accessRole` 'viewer' | 'editor': Access role for the resource (viewer for read-only, editor for read/write)
      - `initial` string: User initials (auto-generated from name if not provided)

## Response `200`

Users updated successfully

- SuccessResponse
  - `result` object
    - `status` 'success'
    - `message` string
    - `data` object: Response data specific to the operation

## Other responses

- `400`: Invalid request

---

[API](https://skmtc.dev/velt-js/apis/velt-rest-api.md) - [All operations](https://skmtc.dev/velt-js/apis/velt-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/velt-js/apis/velt-rest-api/revisions/0f5af15fa267?raw)