Bulk Usergroups by Id
You are viewing legacy documentation. These APIs are maintained for partners with existing implementations. New projects should use v2.
View the current GraphQL API Reference → | View the current REST API Reference →
POST/usergroups/bulk/id
The bulk endpoints offer an efficient way of importing/updating large amounts of usergroups with just a single API call. When using the bulk id endpoint, the usergroups are identified by id. If a usergroup with such id doesn't already exist, it will be created. If it does exist, the usergroup found will be updated.
Usergroup Bulk endpoints support bulk change of attributes for multiple usergroups as well. To learn more about Attributes, go here.
Usergroup Bulk endpoints support bulk change of pricing for multiple usergroups as well. To learn more about Pricing, go here.
A single usergroup's attributes can be modified as explained in Bulk resource attribute values by resource lookup key, but if it's needed to modify attributes for multiple usergroups in a single call, this endpoint should be used.
Fields
| Name | Required |
|---|---|
usergroups (array of usergroup objects) | yes |
id | yes |
name | no |
language | no |
parent | no |
company | no |
department | no |
office | no |
notes | no |
inheritProductList | no Default is Y |
inheritOrderList | no Default is Y |
budget | no Default is N |
budgetInherit | no Default is Y |
orderListAllowAll | no Default is U |
sourceId | no |
source | only when sourceId is provided |
attributes Read more about attributes | no |
pricing Read more about pricing | no |
addresses | no |
Directives
| Name | Description | Fields |
|---|---|---|
skipIfNotEmpty | On update, skip updating fields of an existing usergroup that are not empty | array of field names e.g. name, company etc. |
skipMoveOnUpdate | On update, skip moving an existing usergroup in the parent provided | empty array |
Request
Responses
- 200
- 400
Bulk Usergroups by Id - 200
Response Headers
Bulk Usergroups by Id - 400 (invalid schema)