---
title: "Update User"
method: PATCH
path: "/users/{id}"
tags: ["Users"]
---

# Update User

`PATCH /users/{id}`

Update an existing **User's** attributes using a given `:id`.

## Path parameters

- `id` string, required

## Request body

- UpdateUserRequestBody
  - `first_name` string, required — First name of the user
  - `last_name` string — Last name of the user
  - `email` string — Email of the user. Unique to platform.
  - `mobile` string — International number format. Include '+' and no spaces.
  - `address_line1` string — First line of the user address
  - `address_line2` string — Second line of the user address
  - `state` string — State section of the user address
  - `city` string — City section of the user address
  - `zip` string — Postcode
  - `country` string — [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements) country code (3 char)
  - `dob` string — Date of Birth (DD/MM/YYYY).
  - `government_number` string — Generic parameter to capture important user verification data. eg. SSN for US users, TFN for AU users.
  - `drivers_license_number` string — Driving license number of the user
  - `drivers_license_state` string — State section of the user's driving license
  - `ip_address` string — IP address
  - `logo_url` string — URL link to the logo
  - `color_1` string — Color code number 1
  - `color_2` string — Color code number 2
  - `custom_descriptor` string — When custom_descriptors are enabled, this is the information to appear on bundle direct debit statements (which show the buyer's custom_descriptor) as well as international wire payout, direct credit and PayPal payout statements (which show the seller's custom_descriptor)
  - `authorized_signer_title` string — ‘Authorised Signer Title’, which refers to the role / job title (e.g. Director or General Manager) for the individual User, who is authorised to sign contracts on behalf of the business entity / Merchant User. (Note: information required for AMEX Merchants)

## Response `200`

OK

- SingleUser
  - `users` User
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `full_name` string
    - `email` string, email
    - `mobile` string
    - `phone` string
    - `logo_url` string
    - `color_1` string
    - `color_2` string
    - `first_name` string
    - `last_name` string
    - `id` string
    - `custom_descriptor` string
    - `location` string
    - `verification_status` string
    - `held_state` boolean
    - `roles` string[]
    - `dob` string
    - `government_number` string
    - `drivers_license` string
    - `flags` object
    - `related` object
      - `addresses` string
    - `links` object
      - `self` string
      - `items` string
      - `card_accounts` string
      - `paypal_accounts` string
      - `payid_accounts` string
      - `bpay_accounts` string
      - `bank_accounts` string
      - `wallet_accounts` string

---

[API](https://skmtc.net/hellozai/apis/assembly-api.md) · [All operations](https://skmtc.net/hellozai/apis/assembly-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hellozai/assembly-api/versions/60b528b2e015/schema)