Skip to main content

Bulk Users by Id

POST 

/users/bulk/id

The bulk endpoints offer an efficient way of importing/updating large amounts of user with just a single API call. When using the bulk id endpoint, the products are identified by id. If a user doesn't already exist, it will be created. If it does exist, the user found will be updated.

User Bulk endpoints support bulk change of user attributes for multiple users as well. To learn more about Attributes, go here.

User Bulk endpoints support bulk change of pricing for multiple users as well. To learn more about Pricing, go here.

A single users 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 users, this endpoint should be used.

Fields

NameRequired
users (array of users)yes
idyes
debtorIdno
firstNameno
middleNameno
lastNameno
fullNameno
titleno
dateOfBirthno
genderno
loginno
phoneno
emailno
companyno
parentno
pricelistAmountno
pricelistPercentageno
taxNumberno
cocNumberno
primaryLanguageno
sourceIdno
sourceonly when sourceId is provided
attributes

Read more about attributes
no
pricing

Read more about pricing
no
addresses

Read more about addresses
no

Request

Body

    users

    object[]

  • Array [

  • abbreviation string

    attributes

    object[]

  • Array [

  • class string
    name string
    type string
    value string
  • ]

  • dateOfBirth string
    debtorId number
    email string
    gender string
    id number
    language string
    lastName string
    middleName string
    mobile string

    parent

    object

    id number
    phone string
    title string
  • ]

Responses

Bulk Users 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...