Create chat - Automate.ax

teams.createChat creates a chat with Microsoft 365 users and adds the connected user as an owner.

Example

automations/create-launch-chat.automation.ts

import { automation } from "automate.ax"
import { teams } from "automate.ax/teams"

export default automation("Create launch chat", () => {
  teams.createChat({
    chatType: "group",
    topic: "Launch room",
    participants: [
      { user: "alex@example.com" },
      { user: "guest-user-id", role: "guest" },
    ],
  })
})

Inputs

Input	Type	Required	Default	Description
`chatType`	`"oneOnOne" \| "group"`	Yes	None	Chat kind to create.
`participants`	`{ user: string; role?: "owner" \| "guest" }[]`	Yes	None	Other users by Entra ID or user principal name. Role defaults to `owner`.
`topic`	`string`	Group only	None	Non-empty group-chat title.
Second argument: `{ account }`	`string \| IntegrationAccountReference<"microsoft">`	No	Project default	Microsoft binding.

A one-to-one chat requires exactly one other participant and can’t have a topic. A group chat requires at least two other participants. Use guest only for guest users in the same tenant.

Output

Returns the TeamsChat with chatId, chatType, and available topic, tenant, timestamps, and web URL. Graph may return an existing one-to-one chat between the same people.