Create

1 curl -X POST https://api.flockx.io/api/v1/channels \ 2 -H "Content-Type: application/json" \ 3 -d '{ 4 "type": "websocket", 5 "name": "name", 6 "participants": [ 7 { 8 "type": "authenticated_user", 9 "user_id": "user_id" 10 }, 11 { 12 "type": "authenticated_user", 13 "user_id": "user_id" 14 } 15 ] 16 }'

1 { 2 "id": "id", 3 "type": "websocket", 4 "channel_type": "chat", 5 "name": "name", 6 "participants": [ 7 { 8 "type": "authenticated_user", 9 "user_id": "user_id", 10 "display_name": "display_name", 11 "image_url": "image_url" 12 }, 13 { 14 "type": "authenticated_user", 15 "user_id": "user_id", 16 "display_name": "display_name", 17 "image_url": "image_url" 18 } 19 ], 20 "created_at": "created_at", 21 "modified": "modified" 22 }

Create a new channel.

Request

This endpoint expects an object.

typeenumRequired

The type of communication used for the channel.

Allowed values:

namestringRequired

The name of the channel.

participantslist of objectsRequired

Participants in the channel. There must be at least one agent and one user.

channel_typeenumOptional

The type of channel.

Allowed values:

Response

Successful Response

idstringformat: "uuid"

The ID of the channel.

typeenum

The type of communication used for the channel.

Allowed values:

channel_typeenum

The type of channel.

Allowed values:

namestring

The name of the channel.

participantslist of objects

Participants in the channel.

created_atstringformat: "date-time"

When the channel was created.

modifiedstringformat: "date-time"

When the channel was last modified.