Chat icon

Chat

Interact with the Chat API

Actions253

Agent → Create

AI-generated

Summary

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

Inputs

  • AccountId (required) — Select the account in which to create the agent, either from a searchable list or by specifying the account ID.
  • Name (required) — Full name of the agent.
  • Email (required) — Email address of the agent.
  • Role (required) — Role of the agent, chosen from a list filtered by the selected account or by providing its ID.
  • Additional Fields — Optional fields to specify the agent's full name override, availability status (Available, Busy, Offline), and auto offline behavior (whether status automatically changes to offline when away).

Output shape

A single agent object representing the newly created agent within the specified account.

The output includes fields reflecting the agent's identity, role, and availability settings. All required inputs must be provided for successful creation. Additional optional fields can modify agent availability and behavior.

Examples

Example 1: Create a new support agent in a specific account

Specify the account by selection or ID, provide the agent's name and email, select or specify the role, and optionally set availability or auto offline behavior.

Links

Discussion