createUser

Creates a new User. When creating a new User, the required tags must be provided. See the specific integration for more details.

POST /v1/chat/users

cURL

cURL

curl --request POST \
  --url https://api.botpress.cloud/v1/chat/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-bot-id: <x-bot-id>' \
  --header 'x-bp-authenticated-principal: <x-bp-authenticated-principal>' \
  --data '
{
  "tags": {},
  "integrationName": "<string>",
  "name": "<string>",
  "pictureUrl": "<string>",
  "properties": {},
  "attributes": {}
}
'

201

{
  "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-bp-authenticated-principal · string · required

Authenticated principal. Injected by the authentication middleware.

x-bot-id · string · required

Bot id

x-integration-id · string

Integration id

x-integration-alias · string

Integration alias

x-real-ip · string

Caller's IP address. Injected by the edge proxy.

Body

application/json

User data

tags · object · required

Tags for the User

Show child attributes

integrationName · string · deprecated

[DEPRECATED] To create a User from within a bot, call an action of the integration instead.

Maximum string length: 200

name · string

Name of the user

Maximum string length: 200

pictureUrl · string

URI of the user picture

Maximum string length: 40000

properties · object

EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.

Show child attributes

attributes · object · deprecated

DEPRECATED - Use properties instead.

Show child attributes

Response

201

application/json

Returns a User object if creation succeeds. 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