---
schema: rendered-html/v1
title: "Operations with Specific UserBundle | Developer Portal for YouTrack and Hub Documentation"
source_url: https://www.jetbrains.com/help/youtrack/devportal/operations-api-admin-customFieldSettings-bundles-user.html
generated_at: 2026-06-11T15:03:52.585437+00:00
---

Feedback

Thanks for your feedback!

Was this page helpful?

YesNo

Developer Portal for YouTrack and Hub

- Developer Portal
- Apps
- MCP Tools
- YouTrack Workflows
- YouTrack Import Scripts
- YouTrack Form API
- YouTrack REST API
- Get Started with REST API
- REST API Reference
- Entities
- Resources
- Activity Items
- Issue Activities Page
- Build Bundles
- Enum Bundles
- Owned Bundles
- State Bundles
- User Bundles
- [Operations with Specific UserBundle](operations-api-admin-customFieldSettings-bundles-user.html)
- Sub-resources
- Version Bundles
- Custom Fields
- Field Types
- Backup Files
- Database Backup Settings
- Global Settings
- Organizations
- Projects
- Telemetry data
- Global Time Tracking Settings
- Agiles
- Articles
- Assigned Roles
- Commands
- Command Suggestions
- User Groups
- Issue Link Types
- Issue Tag
- Issues
- Issue Count
- Permissions
- Roles
- Saved Queries
- Search Suggestions
- Tags
- Users
- My User Profile
- Issue Work Items
- REST API Use Cases
- REST API Troubleshooting
- Color Indices List
- Hub REST API

1. YouTrack REST API
2. REST API Reference
3. Resources
4. User Bundles
5. [Operations with Specific UserBundle](#0)

# Operations with Specific UserBundle﻿

Last modified: 19 March 2025

This resource lets you work with the sets of users in YouTrack.

| Resource | ``` /api/admin/customFieldSettings/bundles/user/{bundleID} ``` |
| --- | --- |
| Returned entity | UserBundle. For the description of the entity attributes, see [Supported Fields](/help/youtrack/devportal/operations-api-admin-customFieldSettings-bundles-user.html#UserBundle-supported-fields) section. |
| Supported methods | - `GET`: [Read a Specific UserBundle](/help/youtrack/devportal/operations-api-admin-customFieldSettings-bundles-user.html#get-UserBundle-method). - `POST`: [Update a Specific UserBundle](/help/youtrack/devportal/operations-api-admin-customFieldSettings-bundles-user.html#update-UserBundle-method). - `DELETE`: [Delete a Specific UserBundle](/help/youtrack/devportal/operations-api-admin-customFieldSettings-bundles-user.html#delete-UserBundle-method). |

## UserBundle attributes﻿

Represents a set of values that contains users. You can add to the set both individual user accounts and groups of users.

### Related Resources﻿

Below you can find the list of resources that let you work with this entity.

- User Bundles

Extends Bundle

### Attributes﻿

This table describes attributes of the `UserBundle` entity.

- To receive an attribute in the response from the server, specify it explicitly in the `fields` request parameter.
- To update an attribute, provide it in the body of a POST request.

| Field | Type | Description |
| --- | --- | --- |
| id | String | The ID of the set of users. `Read-only`. |
| groups | Array of UserGroups | User groups that belong to this bundle. |
| individuals | Array of Users | Individual users that belong to this bundle. |
| aggregatedUsers | Array of Users | All users that belong to this bundle. `Read-only`. |
| isUpdateable | Boolean | If `true`, then the currently logged-in user can update this bundle. Otherwise, `false`. `Read-only`. |

## Read a Specific UserBundle﻿

Get the set of users with the specific ID.

### Required permissions﻿

Requires read or update access to one of the fields that use the bundle. If the bundle is not used in any field, Update Project permission is required in at least one project.

### Request syntax﻿

GET /api/admin/customFieldSettings/bundles/user/{bundleID}?{fields}

| {bundleID} | Database ID of the bundle. |
| --- | --- |

### Request parameters﻿

| Parameter | Type | Description |
| --- | --- | --- |
| fields | String | A list of UserBundle attributes that should be returned in the response. If no field is specified, only the `entityID` is returned. |

### Sample﻿

#### Sample request﻿

https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/user/8-20?fields=name,id,isUpdateable,individuals(login,id,name),groups(name,id),aggregatedUsers(name,id,login)

#### Sample response body﻿

  "groups": [],
  "aggregatedUsers": [
      "login": "john.doe",
      "name": "John Doe",
      "id": "1-2",
      "$type": "User"
      "login": "jane.doe",
      "name": "Jane Doe",
      "id": "1-3",
      "$type": "User"
      "login": "Jane_Smith",
      "name": "Jane Smith",
      "id": "1-4",
      "$type": "User"
  ],
  "individuals": [
      "login": "john.doe",
      "name": "John Doe",
      "id": "1-2",
      "$type": "User"
      "login": "jane.doe",
      "name": "Jane Doe",
      "id": "1-3",
      "$type": "User"
      "login": "Jane_Smith",
      "name": "Jane Smith",
      "id": "1-4",
      "$type": "User"
  ],
  "isUpdateable": true,
  "name": "Hero-team",
  "id": "8-20",
  "$type": "UserBundle"

## Update a Specific UserBundle﻿

Change the set of users with the specific ID.

### Required permissions﻿

Requires Update Project permission in all projects where the bundle is used. If the bundle is not used in any field, Update Project permission is required in at least one project.

### Request syntax﻿

POST /api/admin/customFieldSettings/bundles/user/{bundleID}?{fields}

| {bundleID} | Database ID of the bundle. |
| --- | --- |

### Request parameters﻿

| Parameter | Type | Description |
| --- | --- | --- |
| fields | String | A list of UserBundle attributes that should be returned in the response. If no field is specified, only the `entityID` is returned. |

### Sample﻿

Let's add a group of users to the specific set of users, and change the name of this set to 'Heroes'.

#### Sample request﻿

https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/user/8-20?fields=id,name,aggregatedUsers(id,login),groups(name,id)

#### Sample request body﻿

  "groups": [
      "id": "3-2"
  ],
  "name": "Heroes",
  "isUpdateable": true

#### Sample response body﻿

  "groups": [
      "name": "Sample Project Team",
      "id": "3-2",
      "$type": "UserGroup"
  ],
  "aggregatedUsers": [
      "login": "root",
      "id": "1-1",
      "$type": "User"
      "login": "john.doe",
      "id": "1-2",
      "$type": "User"
      "login": "jane.doe",
      "id": "1-3",
      "$type": "User"
      "login": "Jane_Smith",
      "id": "1-4",
      "$type": "User"
  ],
  "name": "Heroes",
  "id": "8-20",
  "$type": "UserBundle"

## Delete a Specific UserBundle﻿

Delete the set of users with the specific ID.

### Required permissions﻿

Requires Update Project permission in all projects where the bundle is used. If the bundle is not used in any field, Update Project permission is required in at least one project.

### Request syntax﻿

DELETE /api/admin/customFieldSettings/bundles/user/{bundleID}

| {bundleID} | Database ID of the bundle. |
| --- | --- |

### Request parameters﻿

| Parameter | Type | Description |
| --- | --- | --- |
| fields | String | A list of UserBundle attributes that should be returned in the response. If no field is specified, only the `entityID` is returned. |

### Sample﻿

#### Sample request﻿

https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/user/8-18

- [Operations with Specific UserBundle](/help/youtrack/devportal/operations-api-admin-customFieldSettings-bundles-user.html)
- [UserBundle attributes](/help/youtrack/devportal/operations-api-admin-customFieldSettings-bundles-user.html#UserBundle-supported-fields)
- [Read a Specific UserBundle](/help/youtrack/devportal/operations-api-admin-customFieldSettings-bundles-user.html#get-UserBundle-method)
- [Update a Specific UserBundle](/help/youtrack/devportal/operations-api-admin-customFieldSettings-bundles-user.html#update-UserBundle-method)
- [Delete a Specific UserBundle](/help/youtrack/devportal/operations-api-admin-customFieldSettings-bundles-user.html#delete-UserBundle-method)

User BundlesAggregated Users in the Bundle

- Privacy & Security
- Terms Of Use
- Trademarks
- Legal

Copyright © 2000–2026 JetBrains s.r.o.
