Skip to main content

Bulk Customers by Id

POST 

/customers/bulk/id

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

Customer bulk endpoints support bulk change of customer attributes for multiple customers as well. To learn more about Attributes, go here.

Customer bulk endpoints support bulk change of pricing for multiple customers as well. To learn more about Pricing, go here.

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

Fields

NameRequired
customers (array of customer objects)yes
idyes
debtorIdno
firstNameno
middleNameno
lastNameno
abbreviationno
titleno
dateOfBirthno
genderno
ssnno
phoneno
emailno
parentno
pricelistAmountno
pricelistPercentageno
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

    customers

    object[]

  • Array [

  • abbreviation string

    addresses

    object[]

  • Array [

  • city string
    code string
    company string
    country string
    email string
    firstName string
    icp string
    isDefault string
    lastName string
    middleName string
    mobile string
    notes string
    number string
    numberExtension string
    phone string
    postalCode string
    region string
    street string
    type string
    url string
  • ]

  • attributes

    object[]

  • Array [

  • class string
    name string
    type string
    value string
  • ]

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

    parent

    object

    id number
    phone string
    primaryLanguage string
    title string
  • ]

Responses

Bulk Customers by Id - 200

Response Headers

  • Alt-Svc

    string

  • Via

    string

  • alt-svc

    string

  • content-length

    string

  • date

    string

  • return-format

    string

  • x-request-id

    string

Schema

    data

    object[]

  • Array [

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

  • messages string[]
    total number
Loading...