HIPE icon

HIPE

Interact with HIPE API

user → Update

AI-generated

Summary

Update a user in the HIPE system by specifying their User ID and providing any subset of user fields to change, such as email, name, phone numbers, role, collaboration associations, external ID, and custom fields.

Inputs

  • User ID (required) — The unique identifier of the user to update.
  • Update Fields — An optional collection of fields to update on the user. This includes email, first name, last name, mobile phone, phone number, role (admin, contact, external sales, guest, sales, super admin), external ID, collaboration IDs (array of UUIDs), and custom fields (JSON).

Output shape

a single user record reflecting the updated user data

The output contains the updated user object as returned by the HIPE API after the update operation completes successfully.

Links

Discussion