Skip to main content

Bulk Usergroups by Id

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

NameRequired
usergroups (array of usergroup objects)yes
idyes
nameno
languageno
parentno
companyno
departmentno
officeno
notesno
inheritProductListno

Default is Y
inheritOrderListno

Default is Y
budgetno

Default is N
budgetInheritno

Default is Y
orderListAllowAllno

Default is U
sourceIdno
sourceonly when sourceId is provided
attributes

Read more about attributes
no
pricing

Read more about pricing
no
addresses

Read more about addresses
no

Directives

NameDescriptionFields
skipIfNotEmptyOn update, skip updating fields of an existing usergroup that are not emptyarray of field names
e.g. name, company etc.
skipMoveOnUpdateOn update, skip moving an existing usergroup in the parent providedempty array

What are directives?

Request

Body

    directives

    object[]

  • Array [

  • fields undefined[]
    operation string
  • ]

  • usergroups

    object[]

  • Array [

  • budget string
    budgetInherit string
    company string
    department string
    id number
    inheritOrderList string
    inheritProductList string
    language string
    notes string
    office string

    parent

    object

    id number
  • ]

Responses

Bulk Usergroups by Id - 200

Response Headers

  • Alt-Svc

    string

  • Via

    string

  • alt-svc

    string

  • content-length

    string

  • date

    string

  • return-format

    string

  • server

    string

  • x-request-id

    string

Schema

    data

    object[]

  • Array [

  • action string
    id number
    key number
    lookupKey string
    success boolean
  • ]

  • messages string[]
    total number
Loading...