---
title: "Invite Agents"
method: POST
path: "/agents/invite"
tags: ["Agents", "Agent"]
---

# Invite Agents

`POST /agents/invite`

## Request

- Base URL: `https://developers.chatway.app/api/v1`
- URL: `https://developers.chatway.app/api/v1/agents/invite`
- Auth: API key in header `X-API-KEY`

Invite one or more teammates to Chatway with POST /agents/invite. Put each teammate in the agents array and provide their email address. Add a name and role when needed.

Choose the invitation role deliberately: CHAT_AGENT_MEMBER requests member access; CHAT_AGENT_ADMIN requests administrator access. Set the role explicitly when the intended access level matters. Check every address before sending a batch, and use an address you control when testing invitations.

## Request body

- object
  - `agents` object[], required: Agents to invite. Each item is an object with a required `email`, an optional `name` and an optional `role` (`CHAT_AGENT_MEMBER` or `CHAT_AGENT_ADMIN`).
    - `email` string, email, required
    - `name` string, nullable
    - `role` string, nullable

## Response `200`

Invitations sent

- object
  - `message` string, required

## Other responses

- `422`: Validation error

---

[API](https://skmtc.dev/chatway/apis/chatway-developer-docs.md) · [All operations](https://skmtc.dev/chatway/apis/chatway-developer-docs/llms.txt) · [OpenAPI document](https://skmtc.dev/chatway/apis/chatway-developer-docs/revisions/ca1a1da291cc?raw)