ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions117

Agents → Add New Agent To Account

AI-generated

Summary

Create a new agent in the specified ChatWoot account by providing the account ID, agent's full name, email, role, availability status, and auto offline setting.

Inputs

  • Account Id (required) — The numeric ID of the ChatWoot account where the agent will be added.
  • Name (required) — Full Name of the new agent.
  • Email (required) — Email address of the new agent.
  • Role (required) — Role assigned to the agent, either 'Agent' or 'Administrator'.
  • Availability Status — Initial availability status of the agent; choices are 'Available', 'Busy', or 'Offline'. Defaults to 'Available'.
  • Auto Offline — Boolean indicating whether the agent's availability automatically switches to offline when away; defaults to true.

Output shape

a single record

The operation returns the details of the newly created agent as a JSON object. No pagination or batching behavior applies to the output.

Discussion