addParticipant

Add a Participant to a Conversation.

POST/conversations/{conversationId}/participants

Header parameters

x-user-keystring

Authentication Key

Path parameters

conversationIdstring

Conversation id

Request body

Participant data

userIdstring

User id

Response

Returns the Participant object

participantobject

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/conversations/{conversationId}/participants \
  --header 'x-user-key: <x-user-key>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": ""
}
'

Response

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