Sign in

v1

latestOpenAPI 3.0.02026-07-1412360190.8 KB
Conversations

Adds the authenticated user to a community

Adds the authenticated user to the given community (i.e., allows the user to join this community). Contrary to the operation of adding a new participant, this operation can only be performed by a user who is not yet a member of the community. OauthScopes: WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS

post/conversations/community/{convId}/join

Path parameters

convIdstring required

The ID of the conversation which the user will join

Response

Gets the conversation object to which the participants was added

avatarstring

The URL of the small avatar image of the conversation

avatarLargestring

The URL of the large avatar image of the conversation

convIdstring

The ID of the conversation

creationTimenumber

UTC timestamp when the conversation was created

creatorIdstring

The ID of the user who created the conversation

creatorTenantIdstring

The ID of the Circuit domain (tenant) where the creator of the conversation belongs to

descriptionstring

The description of the conversation. This field is available only for conversations with type COMMUNITY

isGuestAccessDisabledboolean

Indicates whether guest access to the conversation is disabled or not

isModeratedboolean

Indicates whether the conversation is moderated or not. In a moderated conversation only participants who have been assigned the role of a moderator are allowed to add or remove participants into the conversation

modificationTimenumber

UTC timestamp when the conversation was modified. A conversation is modified when any of the conversation object fields change but not when conversation items are added or edited

participantsstring[]

Array of active participants

topicstring

The title of the conversation. Conversations of type DIRECT cannot have a title

topicPlaceholderstring

The title of the conversation. Conversations of type DIRECT cannot have a title

typestring

The type of the conversation. It can be one of the following: DIRECT, GROUP, COMMUNITY or LARGE