Chatwoot · Schema
Agent
Chatwoot Agent schema
Customer SupportMessagingLive ChatOmni-channelConversationsContactsAgentsOpen Source
Properties
| Name | Type | Description |
|---|---|---|
| id | integer | |
| account_id | integer | |
| availability_status | string | The effective availability status of the agent, derived from the configured availability, auto-offline setting, and current presence. To update an agent's configured availability, use the availability |
| auto_offline | boolean | Whether the agent is automatically marked offline when they are away. |
| confirmed | boolean | Whether the agent has confirmed their email address. |
| string | The email of the agent | |
| available_name | string | The available name of the agent |
| name | string | The name of the agent |
| role | string | The role of the agent |
| thumbnail | string | The thumbnail of the agent |
| custom_role_id | integernull | The custom role id of the agent |
JSON Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"account_id": {
"type": "integer"
},
"availability_status": {
"type": "string",
"enum": [
"online",
"busy",
"offline"
],
"readOnly": true,
"description": "The effective availability status of the agent, derived from the configured availability, auto-offline setting, and current presence. To update an agent's configured availability, use the availability field in create or update requests."
},
"auto_offline": {
"type": "boolean",
"description": "Whether the agent is automatically marked offline when they are away."
},
"confirmed": {
"type": "boolean",
"description": "Whether the agent has confirmed their email address."
},
"email": {
"type": "string",
"description": "The email of the agent"
},
"available_name": {
"type": "string",
"description": "The available name of the agent"
},
"name": {
"type": "string",
"description": "The name of the agent"
},
"role": {
"type": "string",
"enum": [
"agent",
"administrator"
],
"description": "The role of the agent"
},
"thumbnail": {
"type": "string",
"description": "The thumbnail of the agent"
},
"custom_role_id": {
"type": [
"integer",
"null"
],
"description": "The custom role id of the agent"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/chatwoot/main/json-schema/agent.json",
"title": "Agent",
"description": "Chatwoot Agent schema"
}