{
"type": "admin",
"id": "493881",
"name": "Hoban Washburne",
"email": "[email protected]",
"job_title": "Philosopher",
"away_mode_enabled": false,
"away_mode_reassign": false,
"has_inbox_seat": true,
"team_ids": [
814864,
814865
],
"team_priority_level": {
"primary_team_ids": [
814865
],
"secondary_team_ids": [
814864
]
}
}
Admins are the teammate accounts that have access to a workspace.
Object Models
Admin
| Field | Type | Description |
|---|---|---|
| type | string | String representing the object's type. Always has the value admin. |
| id | string | The id representing the admin. |
| name | string | The name of the admin. |
| string | The email of the admin. | |
| job_title | string | The job title of the admin. |
| away_mode_enabled | boolean | Identifies if this admin is currently set in away mode. |
| away_mode_reassign | boolean | Identifies if this admin is set to automatically reassign new conversations to the apps default inbox. |
| has_inbox_seat | boolean | Identifies if this admin has a paid inbox seat to restrict/allow features that require them. |
| team_ids | array | This object represents the avatar associated with the admin. |
| avatar | string | Image for the associated team or teammate |
| team_priority_level | object | Admin priority levels for teams |
Team Priority Level
| Field | Type | Description |
|---|---|---|
| primary_team_ids | array | The primary team ids for the team |
| secondary_team_ids | array | The secondary team ids for the team |
Information on
has_inbox_seatAs inbox seats are a new feature with our new pricing plans, customers not migrated to our new pricing will have
has_inbox_seatset totrue.We only check if the teammate making the API call has seats, not the app itself, nor all admins within the app.
If an admin
has_inbox_seatsset tofalse, then certain calls will fail, such as:Setting an admin to have away mode and/or to reassign conversations
Assigning a conversation to an admin or a team
Adding or removing another customer to a group conversationIf it fails, we let the developer know by returning a 403 Forbidden error, alongside a clarifying error code/message as can be seen in the examples to the right.