Actions129
- Accounts Actions
- Account Users Actions
- Agent Bots Actions
- Users Actions
- Inbox API Actions
- Contacts Actions
- Contact Labels Actions
- Conversation Assignments Actions
- Conversations Actions
- Conversation Add Labels
- Conversation Filter
- Conversation List
- Conversation List Meta
- Get Conversation Reporting Events
- Get Details Of A Conversation
- List All Labels Of A Conversation
- New Conversation
- Toggle Priority Of A Conversation
- Toggle Status Of A Conversation
- Update Conversation
- Update Custom Attributes Of A Conversation
- Custom Filters Actions
- Inboxes Actions
- Integrations Actions
- Messages Actions
- Profile Actions
- Reports Actions
- Automation Rule Actions
- Help Center Actions
- Contacts API Actions
- Conversations API Actions
- Messages API Actions
- CSAT Survey Page Actions
- Account Actions
- Audit Logs Actions
- Account Agent Bots Actions
- Agents Actions
- Canned Responses Actions
- Custom Attributes Actions
- Teams Actions
- Webhooks Actions
- Conversation Actions
Agents → Update Agent In Account
AI-generatedSummary
Update an existing agent's details in a Coghub account by specifying the agent's ID and modifying properties such as role, availability status, and auto offline settings.
Inputs
- Id (required) — The unique identifier of the agent to update.
- Role (required) — The role assigned to the agent, either 'Agent' or 'Administrator'.
- Availability Status — The current availability status of the agent, which can be 'Available', 'Busy', or 'Offline'.
- Auto Offline — Boolean flag indicating whether the agent's availability status will automatically switch to offline when away.
- Request Options — Optional settings to control request behavior, including batching, SSL certificate validation, proxy, and timeout.
Output shape
a single updated agent record
The operation returns the updated agent object reflecting the changes applied. No pagination involved.
Examples
Example 1: Update the role of an agent with ID 123 to administrator and set availability to busy while enabling auto offline.
Set Id=123, Role=Administrator, Availability Status=Busy, Auto Offline=true.