Skip to main content

Interface: ChatFormData

Defined in: packages/sdk/src/types/chat-types.ts:90

Properties

agentEnabled?

optional agentEnabled: boolean

Defined in: packages/sdk/src/types/chat-types.ts:104


agentMemberId?

optional agentMemberId: number | null

Defined in: packages/sdk/src/types/chat-types.ts:113

Deprecated

Use assistantMemberId. Kept as a client-side alias.


assistantChatModelConfig?

optional assistantChatModelConfig: Record<string, unknown> | null

Defined in: packages/sdk/src/types/chat-types.ts:109


assistantChatModelId?

optional assistantChatModelId: string | null

Defined in: packages/sdk/src/types/chat-types.ts:108


assistantMemberId?

optional assistantMemberId: number | null

Defined in: packages/sdk/src/types/chat-types.ts:105


assistantName?

optional assistantName: string | null

Defined in: packages/sdk/src/types/chat-types.ts:107

Per-chat display-name fork; null/omitted uses the Workflow revision.


assistantRealtimeModelConfig?

optional assistantRealtimeModelConfig: Record<string, unknown> | null

Defined in: packages/sdk/src/types/chat-types.ts:111


assistantRealtimeModelId?

optional assistantRealtimeModelId: string | null

Defined in: packages/sdk/src/types/chat-types.ts:110


channel

channel: string

Defined in: packages/sdk/src/types/chat-types.ts:93


chatType?

optional chatType: string

Defined in: packages/sdk/src/types/chat-types.ts:94


id?

optional id: number

Defined in: packages/sdk/src/types/chat-types.ts:91


inboxId?

optional inboxId: number | null

Defined in: packages/sdk/src/types/chat-types.ts:100


initialMessage?

optional initialMessage: string | null

Defined in: packages/sdk/src/types/chat-types.ts:124

Optional human-typed initial SMS/email message body. Treated as PHI: never log it client-side beyond the textarea state. Empty/whitespace-only values are dropped before sending.


isTest?

optional isTest: boolean

Defined in: packages/sdk/src/types/chat-types.ts:118


labelIds?

optional labelIds: number[]

Defined in: packages/sdk/src/types/chat-types.ts:117


memberId?

optional memberId: number | null

Defined in: packages/sdk/src/types/chat-types.ts:102


muted?

optional muted: boolean

Defined in: packages/sdk/src/types/chat-types.ts:115


needsResponse?

optional needsResponse: boolean

Defined in: packages/sdk/src/types/chat-types.ts:116


participants?

optional participants: ChatParticipantFormData[]

Defined in: packages/sdk/src/types/chat-types.ts:103


paused?

optional paused: boolean

Defined in: packages/sdk/src/types/chat-types.ts:114


phoneNumberId?

optional phoneNumberId: number | null

Defined in: packages/sdk/src/types/chat-types.ts:99


siteId?

optional siteId: number | null

Defined in: packages/sdk/src/types/chat-types.ts:101


title?

optional title: string

Defined in: packages/sdk/src/types/chat-types.ts:92


workflowId?

optional workflowId: number | null

Defined in: packages/sdk/src/types/chat-types.ts:95


workflowRevisionId?

optional workflowRevisionId: number | null

Defined in: packages/sdk/src/types/chat-types.ts:97


workflowRevisionUuid?

optional workflowRevisionUuid: string | null

Defined in: packages/sdk/src/types/chat-types.ts:98


workflowUuid?

optional workflowUuid: string | null

Defined in: packages/sdk/src/types/chat-types.ts:96