POST
/
v1
/
chat
/
conversations
/
{id}
/
participants
cURL
curl --request POST \
  --url https://api.botpress.cloud/v1/chat/conversations/{id}/participants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-bot-id: <api-key>' \
  --data '{
  "userId": "<string>"
}'
{
  "participant": {
    "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.

Path Parameters

​
id
string
required

Conversation id

Body

application/json

Participant data

​
userId
string
required

User id

Required string length: 28 - 36

Response

Returns the Participant object

​
participant
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.