---
updatedAt: 2026-07-02T06:56:28.000Z
---

Fetch the complete documentation index at: https://developer.connecteam.com/llms.txt. Use this file to discover all available pages before exploring further.

# Overview

The Chat API enables you to create team chats and channels and send messages programmatically to team chats, channels, and private conversations. Integrate with your systems to automate notifications, alerts, and two-way conversations.

## Key Concepts

### Conversations

Conversations are chat threads in Connecteam. There are two types:

| Type      | Description                         |
| :-------- | :---------------------------------- |
| `team`    | Team chat with multiple members     |
| `channel` | Broadcast channel for announcements |

### Custom Publishers

Custom publishers are bot-like senders that can post messages via the API. They appear as the message author instead of a user.

> 📝 Setting Up Custom Publishers
>
> Custom publishers must be configured in the Connecteam UI:
>
> 1. Go to **Settings** → **Feed settings**
> 2. Create a new custom publisher
> 3. Note the publisher ID to use as `senderId` in API calls

### Private vs Non-Private Conversations

* **Non-private**: Team chats and channels - can be listed via GET endpoint
* **Private**: Direct messages between users - not listed, but you can send to them

***

## Available Endpoints

| Method | Endpoint                                        | Description                   |
| :----- | :---------------------------------------------- | :---------------------------- |
| POST   | /chat/v1/conversations                          | Create a team chat or channel |
| GET    | /chat/v1/conversations                          | Get team chats and channels   |
| POST   | /chat/v1/conversations/{conversationId}/message | Send message to conversation  |
| POST   | /chat/v1/conversations/privateMessage/{userId}  | Send private message to user  |

***

## Constraints

| Constraint                     | Value           |
| :----------------------------- | :-------------- |
| Max message length             | 1000 characters |
| Max conversations per page     | 100             |
| Attachment types               | `image`, `file` |
| Multiple non-image attachments | Not allowed     |

***

## Authentication

All endpoints require authentication via API key or OAuth 2.0.

### Required Scopes

| Scope      | Operations                          |
| :--------- | :---------------------------------- |
| chat.read  | GET conversations                   |
| chat.write | Create conversations, POST messages |

***

## Attachments

To send attachments with messages:

1. Upload the file using the [Attachments API](attachments-overview) with `featureType: chat`
2. Get the `fileId` from the upload response
3. Include the attachment in your message request

> ⚠️ Attachment Rules
>
> * Multiple **image** attachments are allowed
> * Only **one** non-image file attachment is allowed per message
> * Files must be uploaded via Attachments API first

***

## Guide Pages

| Page                                        | Description                                                |
| :------------------------------------------ | :--------------------------------------------------------- |
| [Conversations](chat-conversations)         | Create, list, and send messages to team chats and channels |
| [Private Messages](chat-private-messages)   | Send direct messages to users                              |
| [Custom Publishers](chat-custom-publishers) | Configure bot senders for API messages                     |

***

[API Reference](https://developer.connecteam.com/reference/)