COconnecteam
Chat:v1:Conversations

Create conversation

Creates a team chat or channel as the authenticated user. Members are assigned via userIds (individual users) and/or smartGroupIds (dynamic cohorts) - at least one assignment is required. Use type: "team" for a collaborative chat where members can send messages, or type: "channel" for a broadcast group where only admins post. A custom publisher can subsequently post into the created group via POST /chat/v1/conversations/{conversationId}/message.

post/chat/v1/conversations

Request

  • Base URL
    https://api.connecteam.com
  • URL
    https://api.connecteam.com/chat/v1/conversations
  • Auth
    • API key in header X-API-KEY
    • or OAuth 2
      Client credentials
      Token URL: /oauth/v1/token scopes: chat.write

Request body

titlestring required

The conversation title shown in the chat clients. Must be non-empty after trimming whitespace.

type'team' | 'channel' required

An enumeration.

assignedUserIdsinteger[]

Individual user IDs assigned as members. At least one of assignedUserIds or assignedSmartGroupIds must be provided. Defaults to an empty array.

assignedSmartGroupIdsinteger[]

Smart group (dynamic cohort) IDs assigned to the conversation. Membership follows the smart group's rules. At least one of assignedUserIds or assignedSmartGroupIds must be provided. Defaults to an empty array.

adminUserIdsinteger[]

User IDs granted admin privileges in the conversation (manage members/settings; for channels, the only users who can post). An admin id must also be an assigned member (via assignedUserIds or an assigned smart group) to take effect. If omitted, defaults are applied.

isLockedboolean

Whether the conversation is created locked (members cannot send messages until an admin unlocks it). Defaults to unlocked.

isMembersHiddenboolean

Whether the member list is hidden from members in the chat clients. Defaults to false.

descriptionobject[]

Ordered list of structured rich-text blocks shown in the conversation details (not a chat message). Each block is a typed object, e.g. {"type":"html","html":"<div>...</div>"}. Defaults to an empty array.

Response

Successful Response

requestIdstring

Changes

No recorded changes to this operation across all 2 revisions of this API.