Actions112
- Account Actions
- Account AgentBot Actions
- Agent Actions
- Audit Log Actions
- Automation Rule Actions
- Canned Response Actions
- Contact Actions
- Contact Label Actions
- Conversation Actions
- Conversation Assignment Actions
- Custom Attribute Actions
- Custom Filter Actions
- Help Center Actions
- Inbox Actions
- Integration Actions
- Label Actions
- Message Actions
- Profile Actions
- Report Actions
- Account Conversation Metrics
- Account Reporting Events
- Agent Conversation Metrics
- Get Account Reports
- Get Account Reports Summary
- Get Conversation Statistics Grouped by Agent
- Get Conversation Statistics Grouped by Channel Type
- Get Conversation Statistics Grouped by Inbox
- Get Conversation Statistics Grouped by Team
- Get First Response Time Distribution by Channel
- Get Inbox-Label Matrix Report
- Get Outgoing Messages Count Grouped by Entity
- Team Actions
- Webhook Actions
Agent → Add a New Agent
AI-generatedSummary
Create a new agent in a specified ChatWoot account by providing the account ID, agent's full name, email, and role, with optional availability and auto offline settings.
Inputs
- Account ID (required) — The numeric identifier 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) — Defines if the agent is an 'Agent' or 'Administrator' in the account.
- Additional Options — Optional parameters including availability status ('available', 'busy', 'offline') and auto offline setting (boolean) to configure agent's availability behavior.
Output shape
a single record representing the newly created agent's details as returned by the ChatWoot API
The operation submits a request to create the agent and returns the API's response. Optional request parameters like batching or proxy settings may influence the request but do not affect the returned data shape.
Examples
Example 1: Add an available agent to account ID 5 with administrator role
Set Account ID to 5, Name to 'Jane Doe', Email to 'jane.doe@example.com', Role to 'Administrator', and Availability Status to 'Available' in Additional Options.