ZRM Docs
Domain Model

Message Template

Fields

FieldTypeRequiredDefaultDescription
idstring.uuidYesId
createdAtstring.date-timeYesCreated at
updatedAtstring.date-timeYesUpdated at
namestringYesName
providerenum(telegram, whatsapp, discord, slack, microsoft_teams, ai_agent, email)NoProvider
workspaceIdstringNoID of the associated workspace
subjectTemplatestringNoSubject template
bodyTemplatestringYesBody template
variableSchemaobjectNoVariable schema
categorystringYesCategory
enabledbooleanYesEnabled
visibilityModeenum(global, workspace_local, shared)YesVisibility mode

Create Schema

Fields accepted when creating a new record:

FieldTypeRequiredDefaultDescription
namestringYesName
providerenum(telegram, whatsapp, discord, slack, microsoft_teams, ai_agent, email)NoProvider
workspaceIdstringNoID of the associated workspace
subjectTemplatestringNoSubject template
bodyTemplatestringYesBody template
variableSchemaobjectNoVariable schema
categorystringYesCategory
enabledbooleanYestrueEnabled
visibilityModeenum(global, workspace_local, shared)Yes"workspace_local"Visibility mode

Update Schema

All fields are optional when updating:

FieldTypeRequiredDefaultDescription
namestringNoName
providerenum(telegram, whatsapp, discord, slack, microsoft_teams, ai_agent, email)NoProvider
subjectTemplatestringNoSubject template
bodyTemplatestringNoBody template
variableSchemaobjectNoVariable schema
categorystringNoCategory
enabledbooleanNotrueEnabled

On this page