Update workforce member | Comp AI API

Update a workforce member profile, role, department, or compliance metadata used for people-security controls.

PATCH /v1/people/{id}

Update workforce member

cURL

curl --request PATCH \
  --url https://api.trycomp.ai/v1/people/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "userId": "usr_abc123def456",
  "role": "admin",
  "department": "it",
  "isActive": false,
  "fleetDmLabelId": 123,
  "jobTitle": "Software Engineer",
  "name": "John Doe",
  "email": "[e-mail]",
  "createdAt": "2024-01-15T00:00:00.000Z",
  "backgroundCheckExempt": false
}
'

200

{
  "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": "[e-mail]",
    "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"
  }
}

Authorizations

X-API-Key · string · header · required

API key for authentication

Path Parameters

id · string · required

Member ID

Example:

"mem_abc123def456"

Body

application/json

Member update data

userId · string

User ID to associate with this member

Example:

"usr_abc123def456"

role · string

Role for the member (built-in role name or custom role ID)

Example:

"admin"

department · enum<string>

Member department

Available options: none, admin, gov, hr, it, itsm, qms

Example:

"it"

isActive · boolean

Whether to deactivate this member (soft delete)

Example:

false

fleetDmLabelId · number

FleetDM label ID for member devices

Example:

123

jobTitle · string

Job title for the member

Example:

"Software Engineer"

name · string

Name of the associated user

Example:

"John Doe"

email · string

Email of the associated user

Example:

"[e-mail]"

createdAt · string

Member join date (createdAt override)

Example:

"2024-01-15T00:00:00.000Z"

backgroundCheckExempt · boolean

When true, this member is exempt from the org-level background check requirement and will count as complete in people scores.

Example:

false

Response

200

application/json

Member updated successfully

id · string · required

Member ID

Example:

"mem_abc123def456"

organizationId · string · required

Organization ID this member belongs to

Example:

"org_abc123def456"

userId · string · required

User ID associated with member

Example:

"usr_abc123def456"

role · string · required

Member role

Example:

"admin"

createdAt · string<date-time> · required

When the member was created

Example:

"2024-01-01T00:00:00Z"

department · enum<string> · required

Member department

Available options: none, admin, gov, hr, it, itsm, qms

Example:

"it"

jobTitle · object | null · required

Job title for the member

Example:

"Software Engineer"

isActive · boolean · required

Whether member is active

Example:

true

deactivated · boolean · required

Whether member is deactivated

Example:

false

fleetDmLabelId · object | null · required

FleetDM label ID for member devices

Example:

123

user · object · required

User information

Show child attributes

backgroundCheckRequests · object[]

Background check requests for this member

Show child attributes