Skip to content
CCS Chat Docs

CreateConversationInput

Defined in: libs/ccs-chat-client/src/types.ts:102

Properties

Section titled “Properties”

type

Section titled “type”

type: ConversationType

Defined in: libs/ccs-chat-client/src/types.ts:103

name?

Section titled “name?”

optional name?: string

Defined in: libs/ccs-chat-client/src/types.ts:105

Required for GROUP and CHANNEL.

description?

Section titled “description?”

optional description?: string

Defined in: libs/ccs-chat-client/src/types.ts:106

visibility?

Section titled “visibility?”

optional visibility?: ConversationVisibility

Defined in: libs/ccs-chat-client/src/types.ts:108

CHANNEL only; the API defaults to PUBLIC.

member_user_ids

Section titled “member_user_ids”

member_user_ids: string[]

Defined in: libs/ccs-chat-client/src/types.ts:110

Every id must be an eligible member of the tenant and application (else 422). DIRECT = exactly 2.

actor_user_id?

Section titled “actor_user_id?”

optional actor_user_id?: string

Defined in: libs/ccs-chat-client/src/types.ts:112

Optional tenant user recorded as creator (and GROUP/CHANNEL OWNER). Must be an eligible member.