Skip to main content
PUT
/
v1
/
users
/
bulk
Upsert users bulk
curl --request PUT \
  --url https://api.qobra.co/v1/users/bulk \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "data": [
    {
      "email": "user-test-1@company.com",
      "name": "User 1",
      "role": "Sales Rep",
      "currency": "EUR",
      "calculation_currency": "USD",
      "country": "France",
      "code": "AO32ND56",
      "arrival_date": "2023-12-01",
      "junior": true
    },
    {
      "email": "user-test-2@company.com",
      "name": "User 2",
      "role": "Manager",
      "currency": "USD",
      "calculation_currency": "USD",
      "country": "Germany",
      "code": "AO32ND57",
      "arrival_date": "2024-01-01",
      "junior": false
    },
    "..."
  ]
}
'
{
  "count": "<Upserted user count>",
  "data": [
    {
      "id": "5537a5b05d6e4824940e9e1bb9a5ebb8",
      "email": "user-test-1@company.com",
      "name": "User 1",
      "role": "Sales Rep",
      "currency": "EUR",
      "calculation_currency": "USD",
      "country": "France",
      "code": "AO32ND56",
      "arrival_date": "2023-12-30",
      "junior": true
    },
    {
      "id": "5537a5b05d6e4824940e9e1bb9a5ebb9",
      "email": "user-test-2@company.com",
      "name": "User 2",
      "role": "Manager",
      "currency": "USD",
      "calculation_currency": "USD",
      "country": "Germany",
      "code": "AO32ND57",
      "arrival_date": "2024-01-01",
      "junior": false
    },
    "..."
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.qobra.co/llms.txt

Use this file to discover all available pages before exploring further.

Create new users or update existing ones.

​
How to use user attributes

If you want to add custom columns to your user table, create them in Qobra settings > User attributes first. Custom user attributes definition Those attributes will have an auto-generated API key that you can overwrite. This key will allow you to provide value for those attribute at user creation through API.

​
Variable api keys

This endpoint is based on dynamic fields. This mean that all annotations that look like <variable-key>, will have to or will be replaced by their actual API keys.

​
Behavior

  • Conflict Rule and upsert: Be careful, email field on user is unique. For each user, if it already exist (according to email), we will update the existing one and if it does not exist yet, we will create it.
  • Transaction: If there is at least one user that triggers an error at import, we return you an error and import nothing. You have to fix your payload and send it to us again. And if the answer is a success, it means that every users you sent us have been upserted
  • Empty Field Rule: If you don’t specify a field in upsert, this field won’t be modified. If you want to empty a field, you have to send us a value null associated to the given field api key
  • Limit: you can’t upsert more than 200 users at a time.
  • Error behavior: In case of any error, your users wont be upserted

Authorizations

​
X-API-Key
string
header
required

Body

application/json

The body contains the list of user data necessary to create a new user in Qobra

​
data
UserPutBodyModel · object[]
required

Response

Success operation

​
count
integer
required

Upserted user count

​
data
UsersBulkSuccessModelResponse · object[]
required

Array of upserted users