Participation

Change a user's participation settings

Changes a user's participation settings in a conversation.

If a user is already a participant of a conversation, then you can change the following participation settings:

type of access to the conversation
notification settings

To prevent a participant from being able to read messages from or send messages to a conversation, set their access type to "None".

The change participation operation is idempotent, and can be called multiple times in a row. This call only updates fields given in the payload, leaving the old ones as they were.

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

Request

Base URL
https://api.talkjs.com
Auth
- HTTP bearer
- or HTTP bearer
TypeScript
https://skmtc.dev/talkjs/apis/talkjs-api/docs/v1/:appId/conversations/:conversationId/participants/:userId/patch.ts
A function with typed inputs. Its response is checked against the schema.

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' | 'None'

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

Example request

{
  "access": "None"
}

Response

Empty response

object required