POST
/
v1
/
chat
/
users
/
get-or-create
cURL
curl --request POST \
  --url https://api.botpress.cloud/v1/chat/users/get-or-create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-bot-id: <api-key>' \
  --data '{
  "tags": {},
  "integrationName": "<string>",
  "name": "<string>",
  "pictureUrl": "<string>",
  "discriminateByTags": [
    "<string>"
  ]
}'
{
  "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.

​
x-bot-id
string
header
required

Your bot ID.

Body

application/json

User data

​
tags
object
required

Tags for the User

​
integrationName
string
deprecated

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

Maximum length: 200
​
name
string

Name of the user

Maximum length: 200
​
pictureUrl
string

URI of the user picture

Maximum length: 40000
​
discriminateByTags
string[]

Optional list of tag names to use for strict matching when looking up existing users. If provided, all specified tags must match exactly for a user to be considered a match. For example, with an existing user whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.

Response

Returns a 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.