Invite Agents

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.

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

Request body

Example request

{
  "agents": [
    {
      "email": "john@doe.com",
      "name": "John Doe",
      "role": "CHAT_AGENT_ADMIN"
    }
  ]
}

Response

Invitations sent

messagestring required

Example response

{
  "message": "Invite sent to agent."
}

Changes

No recorded changes to this operation across all 1 revision of this API.