addParticipant

Add a Participant to a Conversation.

POST /conversations/{conversationId}/participants

Add Participant

cURL

curl --request POST \
  --url https://chat.botpress.cloud/{webhookUrl}/conversations/{conversationId}/participants \
  --header 'Content-Type: application/json' \
  --header 'x-user-key: <x-user-key>' \
  --data '
{
  "userId": "<string>"
}
'

200

{
  "participant": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "pictureUrl": "<string>",
    "profile": "<string>"
  }
}

Headers

x-user-key · string · required

Authentication Key

Path Parameters

conversationId · string · required

Conversation id

Body

application/json

Participant data

userId · string · required

User id

Response

200

application/json

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.

Show child attributes