updateUser

Update a User object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

PUT /v1/chat/users/{id}

Try it

cURL

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>"
}
'

200

{
  "user": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "tags": {},
    "name": "<string>",
    "pictureUrl": "<string>"
  }
}

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

Show child attributes

tags. {key} · string

Maximum string length: 500

name · string | null

Name of the user

Maximum string length: 200

pictureUrl · string | null

URI of the user picture

Maximum string length: 40000

Response

200

application/json

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.

Show child attributes

user. id · string · required

Id of the User

Required string length: 28 - 36

user. createdAt · string<date-time> · required

Creation date of the User in ISO 8601 format

user. updatedAt · string<date-time> · required

Updating date of the User in ISO 8601 format

user. tags · object · required

Set of Tags that you can attach to a User. The set of Tags available on a User is restricted by the list of Tags defined previously by the Bot. Individual keys can be unset by posting an empty value to them.

Show child attributes

user.tags. {key} · string

user. name · string

Name of the User

Maximum string length: 200

user. pictureUrl · string

Picture URL of the User

Maximum string length: 40000