Sign in
People

Update workforce member

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

patch/v1/people/{id}

Path parameters

idstring required
Example:mem_abc123def456

Member ID

Request body

userIdstring

User ID to associate with this member

rolestring

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

department'none' | 'admin' | 'gov' | 'hr' | 'it' | 'itsm' | 'qms'

Member department

isActiveboolean

Whether to deactivate this member (soft delete)

fleetDmLabelIdnumber

FleetDM label ID for member devices

jobTitlestring

Job title for the member

namestring

Name of the associated user

emailstring

Email of the associated user

createdAtstring

Member join date (createdAt override)

backgroundCheckExemptboolean

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

backgroundCheckExemptReasonstring

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

backgroundCheckExemptJustificationstring

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

onboardDateobject

Employee onboard date

offboardDateobject

Employee offboard date

Example request

{
  "userId": "usr_abc123def456",
  "role": "admin",
  "department": "it",
  "fleetDmLabelId": 123,
  "jobTitle": "Software Engineer",
  "name": "John Doe",
  "email": "john@example.com",
  "createdAt": "2024-01-15T00:00:00.000Z",
  "backgroundCheckExemptReason": "other",
  "backgroundCheckExemptJustification": "Contractor with existing background check on file from staffing agency."
}

Response

Member updated successfully

idstring required

Member ID

organizationIdstring required

Organization ID this member belongs to

userIdstring required

User ID associated with member

rolestring required

Member role

createdAtstring date-time required

When the member was created

department'none' | 'admin' | 'gov' | 'hr' | 'it' | 'itsm' | 'qms' required

Member department

jobTitleobject nullable required

Job title for the member

isActiveboolean required

Whether member is active

deactivatedboolean required

Whether member is deactivated

fleetDmLabelIdobject nullable required

FleetDM label ID for member devices

Example response

{
  "id": "mem_abc123def456",
  "organizationId": "org_abc123def456",
  "userId": "usr_abc123def456",
  "role": "admin",
  "createdAt": "2024-01-01T00:00:00Z",
  "department": "it",
  "isActive": true,
  "user": {
    "id": "usr_abc123def456",
    "name": "John Doe",
    "email": "john.doe@company.com",
    "emailVerified": true,
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-15T00:00:00Z"
  },
  "backgroundCheckRequests": [
    {
      "id": "bcr_abc123def456",
      "status": "invited"
    }
  ]
}

Changes

Changed in 8 of the 51 revisions of this API.1314

  • aa96d5d213a22See the full diff
    • ○

      added the new optional request property backgroundCheckExemptJustification

      new-optional-request-property

    • ○

      added the new optional request property backgroundCheckExemptReason

      new-optional-request-property

  • 5a440666fc0422See the full diff
    • ●

      removed the request property backgroundCheckExemptJustification

      request-property-removed

    • ●

      removed the request property backgroundCheckExemptReason

      request-property-removed

    • ○

      added the new optional request property offboardDate

      new-optional-request-property

    • ○

      added the new optional request property onboardDate

      new-optional-request-property

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 33d5a775044a2See the full diff
    • ○

      added the new optional request property backgroundCheckExemptJustification

      new-optional-request-property

    • ○

      added the new optional request property backgroundCheckExemptReason

      new-optional-request-property

  • 2db21a9af7bd1See the full diff
    • ○

      added the new optional request property backgroundCheckExempt

      new-optional-request-property

  • 36253e8a5c1b1See the full diff
    • ○

      added the optional property backgroundCheckRequests to the response with the 200 status

      response-optional-property-added

  • 805d5411bc331See the full diff
    • ○

      added the required property deactivated to the response with the 200 status

      response-required-property-added

  • 9b8ae4b8ab6711See the full diff
    • ▲

      removed the required property user/allOf[UserResponseDto]/isPlatformAdmin from the response with the 200 status

      response-required-property-removed

    • ○

      added the required property user/allOf[UserResponseDto]/role to the response with the 200 status

      response-required-property-added

  • 946edaa856a914See the full diff
    • ●

      deleted the header request parameter X-Organization-Id

      request-parameter-removed

    • ○

      added the new optional request property createdAt

      new-optional-request-property

    • ○

      added the new optional request property email

      new-optional-request-property

    • ○

      added the new optional request property name

      new-optional-request-property

    • ○

      added the required property user/allOf[UserResponseDto]/isPlatformAdmin to the response with the 200 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog