Users

users_users_update

Update an end user's profile, status flags and metadata bags.

Tool

users_users_update

Update an end user's profile, status flags and metadata bags.

Update an end user's profile, status flags and metadata bags. Only the fields you pass change. A metadata field REPLACES that whole bag — send the full object you want stored. Write matrix in this phase: the management plane writes all three bags (public: end-user readable and may flow into the JWT; private: management plane only; unsafe: end-user writable later and never authoritative for authorization).

Behavior

HTTP: PATCH /users/users/:userId

Arguments

Name	Type	Required	Description
name	string	—	The user's display name. Pass null to clear.
userId	string	•	The user to update.
imageUrl	string	—	URL of the user's avatar image. Pass null to clear.
waitlisted	boolean	—	Whether the user is still a waitlist signup.
lockedUntil	string	—	ISO-8601 timestamp of a temporary, self-healing lockout — the failed-attempt ceiling sets it and it expires on its own. Pass null to unlock the account immediately (audited as `user.unlocked`).
requiresReset	boolean	—	Whether the user must reset their password before signing in.
publicMetadata	object	—	REPLACES the whole public metadata bag. Management-plane write, end-user read.
unsafeMetadata	object	—	REPLACES the whole unsafe metadata bag. End-user writable in a later phase; never authoritative.
privateMetadata	object	—	REPLACES the whole private metadata bag. Management plane only.

Response

Field	Type	Always
id	string	•
name	string	•
bannedAt	string	•
erasedAt	string	•
imageUrl	string	•
testUser	boolean	•
createdAt	string	•
deletedAt	string	•
productId	string	•
updatedAt	string	•
waitlisted	boolean	•
identifiers	array	•
lockedUntil	string	•
lastSignInAt	string	•
requiresReset	boolean	•
publicMetadata	object	•
unsafeMetadata	object	•
privateMetadata	object	•
emailChangeLockedUntil	string	•

Try it

Update an end user's profile, status flags and metadata bags.

When to use

Example

Ask your agent something like this:

Update an end user's profile, status flags and metadata bags.

The agent will invoke users_users_update with these arguments:

{
  "userId": "<userId>"
}