> For the complete documentation index, see [llms.txt](https://docs.klai.studio/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.klai.studio/reference/apis-and-services/messaging/adding-users-to-channels.md).

# Adding users to channels

## The Channel Object

| key  | description                                                     |
| ---- | --------------------------------------------------------------- |
| name | The name of the channel. It should be unique among your app     |
| mode | One of `ignore`, `listen`, or `receive`. See Chanel Modes below |

```yaml
// example Channel Object
{
  "name": "channel1",
  "mode": "listen"
}
```

### Channel Modes

Channels can be set to three different modes: **ignore**, **listen** or **receive**.

* **ignore**: messages sent from browser to browser, not passing through FileMaker Server;
* **listen**: messages are sent from browser to browser but FileMaker Server receives the message as well;
* **receive**: messages are sent from browser to FileMaker Server, and messages can be sent later via /message/sendmessage endpoint.

| Mode        | Scope                    | Description                                                                                                                                                                                |
| ----------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **ignore**  | anonymous, authenticated | messages sent from browser to browser, not passing through FileMaker Server.                                                                                                               |
| **listen**  | authenticated only       | messages are sent from browser to browser but FileMaker Server receives the message as well.                                                                                               |
| **receive** | authenticated only       | messages are sent from browser to FileMaker Server and not broadcasted directly to the channel. Messages can be sent later via the FM messages script API:`/message/sendmessage` endpoint. |

## Adding users using a FileMaker Script

{% hint style="warning" %}
**Requires Helper File Changes**\
You will need to update your helper file to the latest version to support the new channels API.
{% endhint %}

The **`API - Join Channel`** script accepts an object with two keys **users** and **channels**.

* `users`: it accepts a string with a **user ID** *or* an **array of user IDs**
* `channels`: it accepts an object with **name** and **mode** *or* an **array of objects**, with the same shape.

{% hint style="success" %}
**TIP**: The user `id` is the id of the user in the helper file, not your business file.
{% endhint %}

#### Example Script Parameters

{% tabs %}
{% tab title="Data shape" %}

```yaml
{
    "channels": [
        {
            "name": "channel1",
            "mode": "ignore"
        } 
    ],
    "users": "USER_ID"
}
```

{% endtab %}
{% endtabs %}

## API: Add User to Channel

<mark style="color:green;">`POST`</mark> `https://yourdomain.com/message/adduser`

You can use this method to join users to one or more channels. This is an authenticated request using the API key for the BetterForms network.

#### Headers

| Name         | Type   | Description      |
| ------------ | ------ | ---------------- |
| content-type | string | application/json |
| accept       | string | application/json |

#### Request Body

| Name               | Type   | Description                   |
| ------------------ | ------ | ----------------------------- |
| apiKey             | string | BetterForms network API key   |
| users              | array  | array of user/channel objects |
| users\[0].id       | string | Klai user id from helper file |
| users\[0].channels | array  | an array of channel objects   |

{% tabs %}
{% tab title="201 " %}

```
{
    "users": [
        "USER_1_ID",
        "USER_2_ID"
    ]
}
```

{% endtab %}
{% endtabs %}

#### Example request body

```json
{
  "apiKey": "BFAPI_GENERATED-API-KEY",
  "users": [
    {
      "id": "USER_1_ID",
      "channels": [
        {
          "name": "channel1",
          "mode": "listen"
        },
        {
          "name": "channel2",
          "mode": "receive"
        }
      ]
    },
    {
      "id": "USER_2_ID",
      "channels": [
        {
          "name": "channel1",
          "mode": "listen"
        }
      ]
    }
  ]
}
```

## Notes

* The REST endpoint expects `users` to be an **array of objects**.
* Each object contains the user `id` plus the `channels` to add for that user.
* This is different from the helper-file script shape described earlier on this page, which accepts top-level `users` and `channels` keys separately.

## Joining Anonymous Channels

Users can only be joined to anonymous channels directly from the browser. The current browser tab that executes the action will be the one added to the channel.

A user can be joined to an anonymous channel via a [Klai action ](/reference/actions-processor.md)called **channelJoinAnon.**

**Example:**

```
{
    "action": "channelJoinAnon",
    "options": {
        "channel": "anonymousChatRoom"
    }
}
```

**Learn more:**

{% content-ref url="/pages/EFYRZ3XJWxqaes6gGd2Z" %}
[channelJoinAnon](/reference/actions-processor/actions_overview/channeljoinanonymous.md)
{% endcontent-ref %}