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. 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
addresses Read more about 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

What are directives?

Request

application/json

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

200

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

application/json

Schema

Schema

data

object[]

Array [

action string

id number

key number

lookupKey string

success boolean

]

messages string[]
total number

Example (from schema)

{
  "data": [
    {
      "action": "create",
      "id": 215,
      "key": 250,
      "lookupKey": "sourceId",
      "success": true
    }
  ],
  "messages": [
    "Completed"
  ],
  "total": 1
}

Bulk Usergroups by Id - 200

{
  "data": [
    {
      "action": "create",
      "id": 215,
      "key": 250,
      "lookupKey": "sourceId",
      "success": true
    }
  ],
  "messages": [
    "Completed"
  ],
  "total": 1
}

400

Bulk Usergroups by Id - 400 (invalid schema)

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• server

  string

• x-request-id

  string

application/json

Schema

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 10007,
    "messages": [
      "#/usergroups/0: required key [name] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

Bulk Usergroups by Id - 400 (invalid schema)

{
  "error": {
    "code": 10007,
    "messages": [
      "#/usergroups/0: required key [name] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

Loading...