PUT
/
v1
/
chat
/
users
/
{id}
curl --request PUT \
  --url https://api.botpress.cloud/v1/chat/users/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "tags": {},
  "name": "<string>",
  "pictureUrl": "<string>"
}'
{
  "user": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "tags": {},
    "name": "<string>",
    "pictureUrl": "<string>"
  }
}

Path Parameters

​
id
string
required

User ID

Body

application/json
User data
​
tags
object

Tags for the User

​
name
string

Name of the user

Maximum length: 200
​
pictureUrl
string | null

URI of the user picture

Maximum length: 40000

Response

200
application/json
Returns an updated [User](#schema_user) object if a valid identifier was provided. Returns [an error](#errors) otherwise
​
user
object
required

The user object represents someone interacting with the bot within a specific integration. The same person interacting with a bot in slack and messenger will be represented with two different users.

Was this page helpful?

Suggest editsRaise issue