createUser

Creates a new User. This operation can only be called when using the shared encryption key.

POST/users

Request body

User data

name?string

Name of the User (not a unique identifier)

pictureUrl?string

Picture url of the User

profile?string

Custom profile data of the User encoded as a string(max length: 1000)

id?string

Identifier of the User

Response

Returns a User

userobject

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.

keystring

Request

curl --request POST \ \
  --url https://chat.botpress.cloud/your_default_webhook_url/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "",
  "pictureUrl": "",
  "profile": "",
  "id": ""
}
'

Response

{
  "user": {
    "id": "string",
    "name": "string",
    "pictureUrl": "string",
    "profile": "string",
    "createdAt": "2025-01-15T12:00:00Z",
    "updatedAt": "2025-01-15T12:00:00Z"
  },
  "key": "string"
}