POST
/
v1
/
people
/
bulk
Add multiple members to organization
curl --request POST \
  --url https://api.trycomp.ai/v1/people/bulk \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "members": [
    {
      "userId": "usr_abc123def456",
      "role": "admin",
      "department": "it",
      "isActive": true,
      "fleetDmLabelId": 123
    },
    {
      "userId": "usr_def456ghi789",
      "role": "member",
      "department": "hr",
      "isActive": true
    }
  ]
}'
{
  "created": [
    {
      "id": "mem_abc123def456",
      "organizationId": "org_abc123def456",
      "userId": "usr_abc123def456",
      "role": "member",
      "createdAt": "2024-01-01T00:00:00Z",
      "department": "it",
      "isActive": true,
      "fleetDmLabelId": 123,
      "user": {
        "id": "usr_abc123def456",
        "name": "John Doe",
        "email": "[email protected]",
        "emailVerified": true,
        "image": "https://example.com/avatar.jpg",
        "createdAt": "2024-01-01T00:00:00Z",
        "updatedAt": "2024-01-15T00:00:00Z",
        "lastLogin": "2024-01-15T12:00:00Z"
      }
    }
  ],
  "errors": [
    {
      "index": 2,
      "userId": "usr_xyz789abc123",
      "error": "User [email protected] is already a member of this organization"
    }
  ],
  "summary": {
    "total": 2,
    "successful": 1,
    "failed": 1
  },
  "authType": "api-key",
  "authenticatedUser": {
    "id": "usr_admin123",
    "email": "[email protected]"
  }
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Headers

X-Organization-Id
string

Organization ID (required for session auth, optional for API key auth)

Body

application/json

Bulk member creation data

members
object[]
required

Array of members to create

Example:
[
{
"userId": "usr_abc123def456",
"role": "admin",
"department": "it",
"isActive": true,
"fleetDmLabelId": 123
},
{
"userId": "usr_def456ghi789",
"role": "member",
"department": "hr",
"isActive": true
}
]

Response

Bulk member creation completed

created
object[]

Successfully created members

errors
object[]

Members that failed to be created with error details

summary
object
authType
enum<string>

How the request was authenticated

Available options:
api-key,
session
authenticatedUser
object