getOrCreateUser

Get or create a new User

POST/users/get-or-create

Header parameters

x-user-keystringrequired

Authentication Key

Request body

User data

namestring

Name of the User (not a unique identifier)

pictureUrlstring

Picture url of the User

profilestring

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

Response

Returns a User

userobjectrequired

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.

Request

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

Response

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