Create a new chat

Creates a new chat and returns it in full, exactly as a subsequent GET of the chat would.
members states who is in the chat from creation: each named principal is joined outright, on an explicit grant recorded alongside. Nobody else is put in the chat, the creator included, so name the calling app here if it is to take part. At least one member is required.
Private chats created without a title are unique per set of members: creating another untitled chat with the same members returns the existing chat rather than creating a duplicate. When a title is supplied a new chat is always created. The creator, attributed on the chat's automatically generated header message, is always the caller's authenticated identity and never anything in the request body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Parameters for creating a new chat. members states who is in the chat from creation: each named principal is joined outright, on a grant recorded alongside. Nobody else is put in the chat, the creator included, so name the calling app here if it is to take part. At least one member is required.

string
required

The organisation that owns the chat.

string

Optional display title for the chat; whitespace alone is not a title. An untitled chat is unique per set of members.

access_rule
required

States who may be in a chat — not who is. A rule names the predicate that governs the chat and carries nothing of its own: who is in the chat from creation travels beside it, on the create command's members, and access given afterwards lives in the chat's grants collection. Serialised with an @type discriminator.

members
array of objects, unique
required
length ≥ 1

The principals who are in the chat from creation; nobody else is put in the chat, the creator included. At least one is required.

members*

A principal backed by a regular user.

string
enum
required
Allowed:
string
required

The underlying user.

string

Optional longer description.

string

Optional icon for the chat, given as the id of an existing attachment.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json