Participation

Add a user to a conversation

A user who is added to a conversation is a participant in that conversation. For any participant in a conversation, you can specify the following:

  • type of access to the conversation
  • notification settings

The operation to add a user to a conversation is idempotent, hence you can call it multiple times in a row. A new request always overwrites existing values.

Group chat sizes

You can have a maximum of 100 participants per conversation on the Basic plan and 300 participant on the Growth plan, as well as add guests up to the user limit for your plan. On the Enterprise plan, group chat sizes are customizable to fit your needs.

For more on group chat sizes, see: Group chats.

Conversation history

When you add a user to a conversation, that user has access to all of the conversation history, including any history from before they joined.

Similarly, if you temporarily remove a user from a conversation, and add them again later, that user also has access to the complete conversation history, including messages sent when they weren't part of the conversation.

put/v1/{appId}/conversations/{conversationId}/participants/{userId}

Request

Path parameters

appIdstring required
Example:abcd1234

A unique identifier of your TalkJS app. You can find your app ID on the Settings page of your dashboard.

conversationIdstring required
Example:0123456789abcdef

A unique identifier of a conversation.

userIdstring required
Example:alice

A unique identifier of a user.

Request body

access'ReadWrite' | 'Read'

Indicates the type of access a user has to this conversation.

Example request

{
  "access": "Read"
}

Response

Empty response

object required

Empty response

Changes

No recorded changes to this operation across all 1 revision of this API.