---
title: "PATCH /users/{userId}"
method: PATCH
path: "/users/{userId}"
tags: ["Users"]
---

# PATCH /users/{userId}

`PATCH /users/{userId}`

Update user

## Path parameters

- `userId` integer, required

## Request body

- object
  - `firstName` string
  - `lastName` string
  - `address` AddressPayload
    - `address1` string, required
    - `address2` string
    - `addressSuburb` string
    - `addressCity` string
    - `addressRegion` string
    - `addressPostcode` string
    - `addressCountry` string
  - `payRate` number
  - `chargeOutRate` number
  - `contactItems` object[]
    - `id` number
    - `contactType` 'phone' | 'mobile' | 'other' | 'fax' | 'website', required — The type of this contact item. It can be one of the following: phone, mobile, fax, other, website
    - `contactValue` string, required — The value of this contact item.

## Response `200`

Successful Response

- UserByIdResponse
  - `result` string, required
  - `data` User, required
    - `id` number, required
    - `companyId` number, required
    - `firstName` string, nullable, required
    - `lastName` string, nullable, required
    - `email` string, required
    - `userType` 'contractor' | 'time_sheet_only' | 'field_worker' | 'apprentice' | 'tradesman' | 'advisor' | 'full_user', required
    - `createdAt` string, date-time, required
    - `modifiedAt` string, date-time, required
    - `address` AddressContact, required
      - `id` number, required
      - `address1` string, nullable, required
      - `address2` string, nullable, required
      - `addressSuburb` string, nullable, required
      - `addressCity` string, nullable, required
      - `addressRegion` string, nullable, required
      - `addressPostcode` string, nullable, required
      - `addressCountry` string, nullable, required
    - `contactItems` ContactItem[], nullable — Contact items. Null for callers without the FULL_CONTACT_DETAILS permission; omitted from the user list.
      - `id` number, required
      - `contactType` 'email' | 'phone' | 'mobile' | 'other' | 'fax' | 'website', required — The type of this contact item. It can be one of the following: email, phone, mobile, other, fax, website
      - `contactValue` string, required — The value of this contact item.
    - `payRate` number, nullable, required — The user's pay rate. Null for callers without the EDIT_EMPLOYEE_RATES permission.
    - `chargeOutRate` number, nullable, required — The user's charge-out rate. Null for callers without the EDIT_EMPLOYEE_RATES permission.
    - `status` 'active' | 'disabled' | 'invited', required
    - `isOwner` boolean, required — Whether this user has owner-level access for the company
    - `links` Links[], required
      - `href` string, required
      - `rel` string, required
      - `type` 'GET' | 'POST' | 'PUT' | 'PATCH', required

## Other responses

- `4XX` — Client Request Errors
- `5XX` — Server Errors

---

[API](https://skmtc.dev/fergus/apis/fergus-api.md) · [All operations](https://skmtc.dev/fergus/apis/fergus-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fergus/fergus-api/revisions/b4f232a22363/schema)