Skip to content
Safety RadarSafety RadarSafety Radar Docs

Bulk create or update users

POST
/users/bulk
curl --request POST \
  --url https://safe-api.safetyradar.com/v2/users/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "users": [ { "email": "hello@example.com", "fullName": "example", "phoneNumber": "example", "role": "admin", "externalId": "example", "supervisorId": "example", "departmentId": "example", "locationId": "example", "teamId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "permissionGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } ] }'

Create or update multiple users in a single request. Users are upserted based on externalId. Maximum 1000 users per request.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
users
required
Array<object>
>= 1 items <= 1000 items
object
email
required
string format: email
fullName
required
string
>= 1 characters
phoneNumber
string
nullable /^\+[1-9]\d{6,14}$/
role
string
Allowed values: admin member safety_center_user
externalId
required

External identifier (required for bulk upsert)

string
>= 1 characters
supervisorId
string
departmentId
string
locationId
string
teamId
string format: uuid
permissionGroupId
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

Bulk operation completed

Media typeapplication/json
object
data
required
object
results
required
Array<object>
object
externalId
required
string
success
required
boolean
created
boolean
id
string format: uuid
error
string
summary
required
object
total
required
number
created
required
number
updated
required
number
failed
required
number
Examplegenerated
{
  "data": {
    "results": [
      {
        "externalId": "example",
        "success": true,
        "created": true,
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "error": "example"
      }
    ],
    "summary": {
      "total": 1,
      "created": 1,
      "updated": 1,
      "failed": 1
    }
  }
}

400

Section titled “400”

Bad request

Media typeapplication/json
object
code
required
string
message
required
string
details
object
key
additional properties
nullable
Examplegenerated
{
  "code": "example",
  "message": "example",
  "details": {
    "additionalProperty": "example"
  }
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
code
required
string
message
required
string
details
object
key
additional properties
nullable
Examplegenerated
{
  "code": "example",
  "message": "example",
  "details": {
    "additionalProperty": "example"
  }
}