ChatWoot Platform icon

ChatWoot Platform

Interact with ChatWoot Platform APIs

User → Update a User

AI-generated

Summary

Update the attributes of an existing ChatWoot platform user by specifying the user's ID and optional fields such as custom attributes, display name, email, name, and password.

Inputs

  • ID (required) — The numeric ID of the user to update.
  • Additional Options — Optional fields to include in the update request, including custom attributes (JSON), display name, email, name, and password (which must contain uppercase, lowercase letters, a number, and a special character).

Output shape

JSON object containing the updated user's attributes as returned by the ChatWoot platform API.

This operation sends a PATCH request to the endpoint /platform/api/v1/users/{id} with the updated fields in the request body. The user ID must be specified. Optional fields not provided are not changed. The response body includes the updated user details. No pagination or batch processing applies here.

Links

Discussion