Models

Home/Models

Schemas

Agent

Agent having a conversation with an end-user.

idstringrequired

Unique identifier for the user in your system

Example:"agent_123456"

user_typestringrequired

Type of user

Value:"agent"

namestringrequired

User's display name

Example:"Jane Doe"

emailstring, (email)required

User's email address

Example:"jane.doe@example.com"

photo_urlstring or null, (uri)

URL to user's avatar/profile picture (displayed in Fin Messenger)

Example:"https://example.com/avatars/jane.jpg"

alias_namestring or null

Agent's display alias_name (shown to end-users instead of real name)

Example:"Support Jane"

{
  "id": "agent_123456",
  "user_type": "agent",
  "name": "Jane Doe",
  "email": "jane.doe@example.com",
  "photo_url": "https://example.com/avatars/jane.jpg",
  "alias_name": "Support Jane"
}