v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

Update an Internal User

This API endpoint updates a specific Internal User's client access.

patch/v1/internal-users/{id}

Path parameters

idstring required

The unique ID of the Internal User to update

Request body

isClientAccessLimitedboolean

Whether this internal user has limited client access. When true, the user can only access certain companies. When false, the user has access to all clients. If nothing is selected, the client access setting they have will remain the same.

companyAccessListstring[]

The IDs of the companies this internal user should have access to. Replaces the existing list of companies. Only applicable if the internal user has limited access.

Response

idstring

objectstring

createdAtstring

updatedAtstring

givenNamestring

fallbackColorstring

familyNamestring

emailstring

rolestring

isClientAccessLimitedboolean

companyAccessListstring[]

avatarImageUrlstring

Example response

{
  "id": "192cc6f7-aa88-4dcb-892d-aaa5f6b88a29",
  "object": "internalUser",
  "createdAt": "2026-05-13T18:01:38.149988933Z",
  "updatedAt": "2026-05-13T18:47:05.589927879Z",
  "givenName": "John",
  "fallbackColor": "teal",
  "familyName": "Doe",
  "email": "johndoe@assembly.com",
  "role": "admin",
  "isClientAccessLimited": true,
  "companyAccessList": [
    "352dbb78-00d8-4875-970f-c8e9c08d0957"
  ]
}