Coghub icon

Coghub

Interagir com a API do Coghub

Actions129

Agents → Update Agent In Account

AI-generated

Summary

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.

Links

Discussion