Skip to main content

Interface: ChatFormData

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

Properties​

agentEnabled?​

optional agentEnabled: boolean

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

Deprecated​

Send assistantKind. Accepted as an alias: false ⇒ 'human'.

agentMemberId?​

optional agentMemberId: number | null

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

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:133

assistantChatModelId?​

optional assistantChatModelId: string | null

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

assistantKind?​

optional assistantKind: "ai" | "human"

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

Who answers this chat. The explicit form of the intent agentEnabled used to encode: a boolean cannot tell "this chat has no AI at all" (dm) apart from "this chat's AI is suspended while a person takes a shift" (assignment answered by a human), and the server derives paused from exactly that difference. Prefer this over agentEnabled.

assistantMemberId?​

optional assistantMemberId: number | null

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

The member acting as assistant. Set iff assistantKind is 'human'.

assistantName?​

optional assistantName: string | null

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

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:135

assistantRealtimeModelId?​

optional assistantRealtimeModelId: string | null

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

channel​

channel: string

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

chatType?​

optional chatType: string

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

id?​

optional id: number

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

inboxId?​

optional inboxId: number | null

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

initialMessage?​

optional initialMessage: string | null

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

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:142

labelIds?​

optional labelIds: number[]

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

memberId?​

optional memberId: number | null

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

muted?​

optional muted: boolean

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

needsResponse?​

optional needsResponse: boolean

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

participants?​

optional participants: ChatParticipantFormData[]

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

paused?​

optional paused: boolean

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

phoneNumberId?​

optional phoneNumberId: number | null

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

siteId?​

optional siteId: number | null

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

title?​

optional title: string

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

userMemberId?​

optional userMemberId: number | null

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

The chat's user participant, stated explicitly. memberId remains the wire field the server reads; this names the same member without the "…unless it's the caller" caveat.

workflowId?​

optional workflowId: number | null

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

workflowRevisionId?​

optional workflowRevisionId: number | null

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

workflowRevisionUuid?​

optional workflowRevisionUuid: string | null

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

workflowUuid?​

optional workflowUuid: string | null

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