ZRM Docs
Domain Model

Channel Identity

Fields

FieldTypeRequiredDefaultDescription
idstring.uuidYesId
createdAtstring.date-timeYesCreated at
updatedAtstring.date-timeYesUpdated at
providerenum(telegram, whatsapp, discord, slack, microsoft_teams, ai_agent, email)YesProvider
externalUserIdstringYesID of the associated external user
externalDisplayNamestringNoExternal display name
linkedUserIdstringNoID of the associated linked user
linkedContactIdstringNoID of the associated linked contact
verificationMethodenum(one_time_code, magic_link, portal_handoff, account_binding)NoVerification method
verifiedAtstring.date-timeNoVerified at
revokedAtstring.date-timeNoRevoked at
workspaceIdstringYesID of the associated workspace

Create Schema

Fields accepted when creating a new record:

FieldTypeRequiredDefaultDescription
providerenum(telegram, whatsapp, discord, slack, microsoft_teams, ai_agent, email)YesProvider
externalUserIdstringYesID of the associated external user
externalDisplayNamestringNoExternal display name
linkedUserIdstringNoID of the associated linked user
linkedContactIdstringNoID of the associated linked contact
verificationMethodenum(one_time_code, magic_link, portal_handoff, account_binding)NoVerification method
verifiedAtstring.date-timeNoVerified at
revokedAtstring.date-timeNoRevoked at
workspaceIdstringYesID of the associated workspace

Update Schema

All fields are optional when updating:

FieldTypeRequiredDefaultDescription
externalDisplayNamestringNoExternal display name
linkedUserIdstringNoID of the associated linked user
linkedContactIdstringNoID of the associated linked contact
verificationMethodenum(one_time_code, magic_link, portal_handoff, account_binding)NoVerification method
verifiedAtstring.date-timeNoVerified at
revokedAtstring.date-timeNoRevoked at

On this page