Skip to content
Home/
REST API Reference
/
/
Activity Log Metadata

Activity Log Metadata

Additional data provided about Admin activity.

sign_in_methodstring or null

The way the admin signed in.

Example:"email_password"
external_idstring or null

The unique identifier for the contact which is provided by the Client.

Example:"f3b87a2e09d514c6c2e79b9a"
away_modeboolean or null

The away mode status which is set to true when away and false when returned.

Example:true
away_status_reasonstring or null

The reason the Admin is away.

Example:"😌 On a break"
reassign_conversationsboolean or null

Indicates if conversations should be reassigned while an Admin is away.

Example:false
sourcestring or null

The action that initiated the status change.

Example:"admin update from web - Admin id: 93"
auto_changedstring or null

Indicates if the status was changed automatically or manually.

Example:false
update_byinteger or null

The ID of the Admin who initiated the activity.

Example:93
update_by_namestring or null

The name of the Admin who initiated the activity.

Example:"Joe Example"
conversation_assignment_limitinteger or null

The conversation assignment limit value for an admin.

Example:15
ticket_assignment_limitinteger or null

The ticket assignment limit value for an admin.

Example:20
teamobject or null

The team whose assignment limit was changed.

team_assignment_limitinteger or null

The assignment limit value for the team. Can be null when unset.

Example:10
{
  "sign_in_method": "email_password",
  "external_id": "f3b87a2e09d514c6c2e79b9a",
  "away_mode": true,
  "away_status_reason": "😌 On a break",
  "reassign_conversations": false,
  "source": "admin update from web - Admin id: 93",
  "auto_changed": false,
  "update_by": 93,
  "update_by_name": "Joe Example",
  "conversation_assignment_limit": 15,
  "ticket_assignment_limit": 20,
  "team": {
    "id": "814865",
    "name": "Support Team"
  },
  "team_assignment_limit": 10
}