Bulk Users by source id

POST 
/users/bulk/sourceId

The bulk endpoints offer an efficient way of importing/updating large amounts of user with just a single API call. When using the bulk sourceId endpoint, the users are identified by sourceId, source and language. 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. 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

Name	Required
users (array of users)	yes
source	yes
sourceId	yes
debtorId	no
firstName	no
middleName	no
lastName	no
fullName	no
title	no
dateOfBirth	no
gender	no
login	no
phone	no
email	no
company	no
parent	no
taxNumber	no
cocNumber	no
primaryLanguage	no
attributes Read more about attributes	no
addresses Read more about addresses	no

Request

application/json

Body

users

object[]

Array [

abbreviation string

attributes

object[]

Array [

class string

name string

type string

value string

]

debtorId number

email string

gender string

language string

lastName string

middleName string

mobile string

parent

object

language string

source string

sourceId number

phone string

source string

sourceId number

title string

]

Responses

200

Bulk Users by source id - 200 / Bulk Users by source 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": "update",
      "id": 14713,
      "key": 3002196,
      "lookupKey": "sourceId",
      "success": true
    }
  ],
  "messages": [
    "Completed"
  ],
  "total": 1
}

Bulk Users by source id - 200

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

400

Bulk Users by source id - 400 (invalid schema) / Bulk Users by source 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": [
      "#/users/0: required key [firstName] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

Bulk Users by source id - 400 (invalid schema)

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

Loading...