ZRM Docs
Domain Model

Conversation

Fields

FieldTypeRequiredDefaultDescription
idstring.uuidYesId
createdAtstring.date-timeYesCreated at
updatedAtstring.date-timeYesUpdated at
workspaceIdstringYesID of the associated workspace
providerenum(telegram, whatsapp, discord, slack, microsoft_teams, ai_agent, email)YesProvider
channelEndpointIdstringYesID of the associated channel endpoint
subjectstringNoSubject
linkedRecordTypestringNoLinked record type
linkedRecordIdstringNoID of the associated linked record
stateenum(open, waiting_on_customer, waiting_on_agent, escalated, resolved, closed)YesState
ownerUserIdstringNoID of the associated owner user
assignedAgentIdstringNoID of the associated assigned agent
requireSessionVerificationbooleanYesRequire session verification
visibilityModeenum(global, workspace_local, shared)YesVisibility mode
accountResolutionStatusenum(auto_matched, confirmed, corrected)NoAccount resolution status
accountResolutionConfidencenumberNoAccount resolution confidence

Create Schema

Fields accepted when creating a new record:

FieldTypeRequiredDefaultDescription
workspaceIdstringYesID of the associated workspace
providerenum(telegram, whatsapp, discord, slack, microsoft_teams, ai_agent, email)YesProvider
channelEndpointIdstringYesID of the associated channel endpoint
subjectstringNoSubject
linkedRecordTypestringNoLinked record type
linkedRecordIdstringNoID of the associated linked record
stateenum(open, waiting_on_customer, waiting_on_agent, escalated, resolved, closed)Yes"open"State
ownerUserIdstringNoID of the associated owner user
assignedAgentIdstringNoID of the associated assigned agent
requireSessionVerificationbooleanYesfalseRequire session verification
visibilityModeenum(global, workspace_local, shared)Yes"workspace_local"Visibility mode
accountResolutionStatusenum(auto_matched, confirmed, corrected)NoAccount resolution status
accountResolutionConfidencenumberNoAccount resolution confidence

Update Schema

All fields are optional when updating:

FieldTypeRequiredDefaultDescription
subjectstringNoSubject
linkedRecordTypestringNoLinked record type
linkedRecordIdstringNoID of the associated linked record
stateenum(open, waiting_on_customer, waiting_on_agent, escalated, resolved, closed)No"open"State
ownerUserIdstringNoID of the associated owner user
assignedAgentIdstringNoID of the associated assigned agent
requireSessionVerificationbooleanNofalseRequire session verification
accountResolutionStatusenum(auto_matched, confirmed, corrected)NoAccount resolution status
accountResolutionConfidencenumberNoAccount resolution confidence

On this page