---
title: "Update a user"
method: PATCH
path: "/platform/api/v1/users/{id}"
tags: ["Users"]
---

# Update a user

`PATCH /platform/api/v1/users/{id}`

Update a user's attributes

## Request body

- UserCreateUpdatePayload
  - `name` string — Name of the user
  - `display_name` string — Display name of the user
  - `email` string — Email of the user
  - `password` string — Password must contain uppercase, lowercase letters, number and a special character
  - `custom_attributes` object — Custom attributes you want to associate with the user

## Response `200`

Success

- User
  - `id` number
  - `access_token` string
  - `account_id` number
  - `available_name` string
  - `avatar_url` string
  - `confirmed` boolean
  - `display_name` string, nullable
  - `message_signature` string, nullable
  - `email` string
  - `hmac_identifier` string
  - `inviter_id` number, nullable
  - `name` string
  - `provider` string
  - `pubsub_token` string
  - `role` 'agent' | 'administrator'
  - `ui_settings` object
  - `uid` string
  - `type` string, nullable
  - `custom_attributes` object — Available for users who are created through platform APIs and has custom attributes associated.
  - `accounts` object[]
    - `id` number
    - `name` string
    - `status` string
    - `active_at` string, date-time, nullable
    - `role` 'administrator' | 'agent'
    - `permissions` string[]
    - `availability` string
    - `availability_status` string
    - `auto_offline` boolean
    - `custom_role_id` number, nullable
    - `custom_role` object, nullable

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.net/chatwoot/apis/chatwoot-2.md) · [All operations](https://skmtc.net/chatwoot/apis/chatwoot-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/chatwoot/chatwoot-2/versions/f34a278f2713/schema)