An Agent is a staff member in your Subiz account. Agents reply to customers, join conversations, and own conversations as the assignee. Customers are User objects, not agents. All IDs and values below are illustrative.
To get agents, see List agents and Get agent details.
Agent
Selected fields of an Agent:
{
"id": "agent_example",
"account_id": "account_example",
"type": "agent",
"state": "active",
"fullname": "Sam Example",
"email": "sam@example.com",
"phone": "+84900000001",
"avatar_url": "https://example.com/avatars/sam.png",
"lang": "en",
"timezone": "Asia/Ho_Chi_Minh",
"scopes": [
"supervisor"
],
"invited_by": "agent_owner_example",
"joined": 1763107200000,
"modified": 1763193600000
}
| Field | Type | Description |
|---|---|---|
id |
string | Agent ID. Use it as assignee when assigning a conversation, or as the member id when inviting an agent. |
account_id |
string | The account the agent belongs to. |
type |
string | agent for a staff member, or bot. Empty means agent. |
state |
string | Agent state. See States. |
fullname |
string | Display name. |
email |
string | Email address. |
phone |
string | Phone number. |
avatar_url, avatar_url_128 |
string | Avatar image, and a 128×128 version. |
gender |
string | male or female, when set. |
lang |
string | Preferred language. |
timezone |
string | Time zone. |
scopes |
array | Account-level roles, such as owner or supervisor. |
invited_by |
string | ID of the agent who invited this agent. |
client_id |
string | For bots: the ID of the bot. |
extension |
integer | Phone extension number, when set. |
joined, modified |
integer | Timestamps when the agent joined the account and when the record last changed. |
Empty fields are omitted, and the object has more fields than shown. account_id is the account’s ID; the account object itself uses id.
States
state |
Meaning |
|---|---|
pending |
Invited, waiting for the invitation to be accepted. |
active |
Active staff member. |
inactive |
Deactivated. |
deleted |
Removed from the account. |
When you choose an agent to invite or assign, pick one whose type is agent and whose state is active.
Agents and customers
| Agent | User | |
|---|---|---|
| Who | Your staff | Your customers |
| Name | fullname field |
fullname attribute |
| In a conversation | Member or assignee |
Member |
See User and attribute format for the customer object.