API Reference

Create conversation

post
https://api.connecteam.com/chat/v1/conversations

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

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

string
enum
required

An enumeration.

Allowed:
assignedUserIds
array of integers

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

Assigneduserids
assignedSmartGroupIds
array of integers

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.

Assignedsmartgroupids
adminUserIds
array of integers

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.

Adminuserids
boolean

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

boolean
Defaults to false

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

description
array of objects

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":"

...
"}. Defaults to an empty array.

Description
Responses

Updated 19 days ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 19 days ago

Did this page help you?