Sign in
latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

User

Update user info

Update information about an user. Only fields that are specified in the request are updated.

Permissions

This endpoint requires the following permissions:

  • User:UpdateUserInfo for the user to update.
post/v1/{organization}/user/{requested_user_id}

Path parameters

requested_user_idstring required

The identifier of the user to update information for.

The identifier of the user to update information for.

organizationstring required

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Request body

first_namestring
last_namestring
enable_response_recommendationboolean nullable

Whether to automatically recommend responses to the user if the user hasn't replied to the coach for a while. If null, the preference is not modified.

conversations_visible_to_adminsboolean nullable

Whether conversations are visible to the admins. If null, the preference is not modified.

user_model_visible_to_adminsboolean nullable

Whether the user's user model is visible to the admins. If null, the preference is not modified.

additional_contextAmigoLibPydanticBaseModelStrippedNonemptyString1[] nullable

A list of additional context to update. If null, the context is not modified.

audio_keytermsStrippedNonemptyStringAZAZ02[] nullable

A list of keyterms that are easy to get wrong during audio transcriptions that tend to occur commonly in audio sessions using this service. If null, the keyterms are not modified.

Response

Succeeded.