Update workforce member

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": "john@example.com",
  "createdAt": "2024-01-15T00:00:00.000Z",
  "backgroundCheckExempt": false,
  "backgroundCheckExemptReason": "other",
  "backgroundCheckExemptJustification": "Contractor with existing background check on file from staffing agency.",
  "onboardDate": "2026-01-15T00:00:00.000Z",
  "offboardDate": "2026-04-30T00:00:00.000Z"
}
'

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    userId: 'usr_abc123def456',
    role: 'admin',
    department: 'it',
    isActive: false,
    fleetDmLabelId: 123,
    jobTitle: 'Software Engineer',
    name: 'John Doe',
    email: 'john@example.com',
    createdAt: '2024-01-15T00:00:00.000Z',
    backgroundCheckExempt: false,
    backgroundCheckExemptReason: 'other',
    backgroundCheckExemptJustification: 'Contractor with existing background check on file from staffing agency.',
    onboardDate: '2026-01-15T00:00:00.000Z',
    offboardDate: '2026-04-30T00:00:00.000Z'
  })
};

fetch('https://api.trycomp.ai/v1/people/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.trycomp.ai/v1/people/{id}"

payload = {
    "userId": "usr_abc123def456",
    "role": "admin",
    "department": "it",
    "isActive": False,
    "fleetDmLabelId": 123,
    "jobTitle": "Software Engineer",
    "name": "John Doe",
    "email": "john@example.com",
    "createdAt": "2024-01-15T00:00:00.000Z",
    "backgroundCheckExempt": False,
    "backgroundCheckExemptReason": "other",
    "backgroundCheckExemptJustification": "Contractor with existing background check on file from staffing agency.",
    "onboardDate": "2026-01-15T00:00:00.000Z",
    "offboardDate": "2026-04-30T00:00:00.000Z"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "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": "john.doe@company.com",
    "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"
  }
}

{
  "message": "User user@example.com is already a member of this organization"
}

{
  "message": "Unauthorized"
}

{
  "message": "Member with ID mem_abc123def456 not found in organization org_abc123def456"
}

{
  "message": "Internal server error"
}

PATCH

people

{id}

Update workforce member

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": "john@example.com",
  "createdAt": "2024-01-15T00:00:00.000Z",
  "backgroundCheckExempt": false,
  "backgroundCheckExemptReason": "other",
  "backgroundCheckExemptJustification": "Contractor with existing background check on file from staffing agency.",
  "onboardDate": "2026-01-15T00:00:00.000Z",
  "offboardDate": "2026-04-30T00:00:00.000Z"
}
'

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    userId: 'usr_abc123def456',
    role: 'admin',
    department: 'it',
    isActive: false,
    fleetDmLabelId: 123,
    jobTitle: 'Software Engineer',
    name: 'John Doe',
    email: 'john@example.com',
    createdAt: '2024-01-15T00:00:00.000Z',
    backgroundCheckExempt: false,
    backgroundCheckExemptReason: 'other',
    backgroundCheckExemptJustification: 'Contractor with existing background check on file from staffing agency.',
    onboardDate: '2026-01-15T00:00:00.000Z',
    offboardDate: '2026-04-30T00:00:00.000Z'
  })
};

fetch('https://api.trycomp.ai/v1/people/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.trycomp.ai/v1/people/{id}"

payload = {
    "userId": "usr_abc123def456",
    "role": "admin",
    "department": "it",
    "isActive": False,
    "fleetDmLabelId": 123,
    "jobTitle": "Software Engineer",
    "name": "John Doe",
    "email": "john@example.com",
    "createdAt": "2024-01-15T00:00:00.000Z",
    "backgroundCheckExempt": False,
    "backgroundCheckExemptReason": "other",
    "backgroundCheckExemptJustification": "Contractor with existing background check on file from staffing agency.",
    "onboardDate": "2026-01-15T00:00:00.000Z",
    "offboardDate": "2026-04-30T00:00:00.000Z"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "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": "john.doe@company.com",
    "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"
  }
}

{
  "message": "User user@example.com is already a member of this organization"
}

{
  "message": "Unauthorized"
}

{
  "message": "Member with ID mem_abc123def456 not found in organization org_abc123def456"
}

{
  "message": "Internal server error"
}

Authorizations

X-API-Key

string

header

required

API key for authentication

Path Parameters

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

string

Member department. Built-in values: none, admin, gov, hr, it, itsm, qms. Custom department names are also accepted.

Maximum string length: 64

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"

string

Email of the associated user

Example:

"john@example.com"

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

backgroundCheckExemptReason

string

Reason code for the exemption (e.g. "contractor_with_vendor_check", "other"). Persisted alongside backgroundCheckExempt and cleared when the member becomes non-exempt.

Example:

"other"

backgroundCheckExemptJustification

string

Free-text justification for the exemption, attached to the audit log. Cleared when the member becomes non-exempt.

Example:

"Contractor with existing background check on file from staffing agency."

onboardDate

object

Employee onboard date

Example:

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

offboardDate

object

Employee offboard date

Example:

"2026-04-30T00:00:00.000Z"

Response

Member updated successfully

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

string

required

Member department. May be one of the built-in values (none, admin, gov, hr, it, itsm, qms) or a custom department name.

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

Delete member Get training video completions for a member

⌘I

Overview

Reference

Update workforce member | Comp AI API

Authorizations

Path Parameters

Body

Response