Skip to navigation

Create realtime conversation group

Create a realtime conversation group owned by the current user.

Headers

xi-api-keystringOptional

Request

This endpoint expects an object.
titlestringRequired
Name of the conversation group. Names are unique per workspace, ignoring case and extra whitespace, and at most 64 characters.
descriptionstringOptional<=500 characters
Optional description of the conversation group.

Response

Successful Response
idstring
titlestring
access_infoobject
sharingobject

How widely a group is shared, besides its owner and workspace admins (who always have access).

created_at_unix_secsinteger
descriptionstringOptional

Errors

422
Realtime Create Conversation Group Request Unprocessable Entity Error