ZRM Docs
API ReferenceConversation

conversation.create

Type: Mutation · Auth: Workspace-aware

Input

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

Example

{
  "workspaceId": "550e8400-e29b-41d4-a716-446655440000",
  "provider": "telegram",
  "channelEndpointId": "550e8400-e29b-41d4-a716-446655440000",
  "subject": "example",
  "linkedRecordType": "example",
  "linkedRecordId": "550e8400-e29b-41d4-a716-446655440000",
  "state": "open",
  "requireSessionVerification": false,
  "visibilityMode": "global"
}

On this page