Skip to main content
PUT
/
v1
/
chat
/
users
/
{id}
cURL
curl --request PUT \
  --url https://api.botpress.cloud/v1/chat/users/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-bot-id: <x-bot-id>' \
  --data '
{
  "tags": {},
  "name": "<string>",
  "pictureUrl": "<string>",
  "attributes": {},
  "properties": {}
}
'
{
  "user": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "tags": {},
    "name": "<string>",
    "pictureUrl": "<string>",
    "properties": {},
    "attributes": {}
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-bot-id
string
required

Bot id

x-integration-id
string

Integration id

x-integration-alias
string

Integration alias

Path Parameters

id
string
required

User ID

Body

application/json

User data

tags
object

Tags for the User

name
string | null

Name of the user

Maximum string length: 200
pictureUrl
string | null

URI of the user picture

Maximum string length: 40000
attributes
object
deprecated

DEPRECATED - Use properties instead.

properties
object

EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations. Set individual properties to null to remove them.

Response

Returns an updated User object if a valid identifier was provided. Returns an error 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.

Last modified on March 20, 2026