Chatwoot icon

Chatwoot

Interact with Chatwoot API to manage conversations, messages, contacts, and more

Actions206

Agent → Update

AI-generated

Summary

Update an existing agent's details including name, role, availability status, and auto offline setting in Chatwoot.

Inputs

  • agentId (required) — Select or specify the ID of the agent to update.
  • updateFields — Fields to update for the agent such as Name, Role (Agent or Administrator), Availability Status (Available, Busy, Offline), and Auto Offline flag.

Output shape

A single JSON object representing the updated agent.

The response contains the updated agent data. Only the fields provided in updateFields will be changed. The agentId is required to identify which agent to update.

Examples

Example 1: Update an agent's availability status to 'Busy' and set auto offline to false.

Specify the agent ID and set the updateFields to availability_status: busy and auto_offline: false.

Links

Discussion