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.

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

Name	Required
customers (array of customer objects)	yes
id	yes
debtorId	no
firstName	no
middleName	no
lastName	no
abbreviation	no
title	no
dateOfBirth	no
gender	no
ssn	no
phone	no
email	no
parent	no
primaryLanguage	no
sourceId	no
source	only when sourceId is provided
attributes Read more about attributes	no
addresses Read more about addresses	no

Request

application/json

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

200

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

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": "update",
      "id": 25494,
      "key": 25494,
      "lookupKey": "id",
      "success": true
    }
  ],
  "messages": [
    "Completed"
  ],
  "total": 1
}

Bulk Customers by Id - 200

{
  "data": [
    {
      "action": "update",
      "id": 25494,
      "key": 25494,
      "lookupKey": "id",
      "success": true
    }
  ],
  "messages": [
    "Completed"
  ],
  "total": 1
}

400

Bulk Customers by Id - 400 (invalid schema)

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  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": [
      "#/customers/0: extraneous key [company] is not permitted"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

Bulk Customers by Id - 400 (invalid schema)

{
  "error": {
    "code": 10007,
    "messages": [
      "#/customers/0: extraneous key [company] is not permitted"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

Loading...