Chat API
- Introduction
- Endpoints
Admin API
- Getting started
- Concepts
- Endpoints
Files API
Tables API
- Getting Started
- Endpoints
Runtime API
- Getting Started
- Concepts
- Endpoints
- POSTcreateConversation
- GETlistConversations
- GETgetConversation
- PUTupdateConversation
- DELdeleteConversation
- POSTgetOrCreateConversation
- GETlistParticipants
- POSTaddParticipant
- GETgetParticipant
- DELremoveParticipant
- POSTcreateEvent
- GETlistEvents
- GETgetEvent
- POSTcreateMessage
- GETlistMessages
- POSTgetOrCreateMessage
- GETgetMessage
- PUTupdateMessage
- DELdeleteMessage
- POSTcreateUser
- GETlistUsers
- GETgetUser
- PUTupdateUser
- DELdeleteUser
- POSTgetOrCreateUser
- POSTsetStateExpiry
- GETgetState
- POSTsetState
- PATCHpatchState
- POSTgetOrSetState
- POSTcallAction
- POSTconfigureIntegration
- GETlistTagValues
- POST
addParticipant
Add a Participant to a Conversation.
POST
/
v1
/
chat
/
conversations
/
{id}
/
participants
Copy
curl --request POST \
--url https://api.botpress.cloud/v1/chat/conversations/{id}/participants \
--header 'Content-Type: application/json' \
--data '{
"userId": "<string>"
}'
Copy
{
"participant": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"tags": {},
"name": "<string>",
"pictureUrl": "<string>"
}
}
Path Parameters
Conversation id
Body
application/json
Participant data
The body is of type object
.
Response
200
application/json
Returns the Participant object
The response is of type object
.
Was this page helpful?
Copy
curl --request POST \
--url https://api.botpress.cloud/v1/chat/conversations/{id}/participants \
--header 'Content-Type: application/json' \
--data '{
"userId": "<string>"
}'
Copy
{
"participant": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"tags": {},
"name": "<string>",
"pictureUrl": "<string>"
}
}
Assistant
Responses are generated using AI and may contain mistakes.