ChatWoot Application icon

ChatWoot Application

Interact with ChatWoot Application APIs

Actions112

Inbox → Add a New Agent

AI-generated

Summary

Add one or more users as agents to a specified inbox within a ChatWoot account by their user IDs.

Inputs

  • Account ID (required) — The numeric ID of the ChatWoot account to which the inbox belongs.
  • Inbox ID (required) — The ID of the inbox where users will be added as agents.
  • User IDs (required) — A JSON array containing the IDs of users to add as agents to the inbox.

Output shape

The operation returns the API response from ChatWoot confirming the addition of users to the inbox as agents, typically including details about the assigned agents.

The inputs are routed in the request body. Optional request options can control batching, SSL handling, proxy, and timeout behavior. No pagination is involved.

Examples

Example 1: Add users with IDs [5, 10] as agents to inbox 123 in account 1

Set Account ID to 1, Inbox ID to 123, and User IDs to [5,10].

Links

Discussion